# SA2

## karabo

[add component documentation]

### SA2interlockMonitor

Instance id: | karabo/SA2interlockMonitor
Class id: | InterlockMonitor
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/interlockMonitor
Last modified: | 2021-05-25T12:52:43.000+02:00
Created at: | 2018-10-10T10:28:32.000+02:00
Main authors: | Parenti, Hauf, Silenzi
Latest tag: | 0.2.4-2.11.0
Deployment tag: | 0.2.4-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

#### Device Schema Description

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

#### Release History

##### 0.2.4-2.11.0

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

##### 0.2.3-2.10.0

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

##### 0.2.2-2.10.0

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

##### 0.2.1-2.9.0

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

##### 0.2.0-2.9.0

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

##### 0.1.1-2.3.0

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

##### 0.1.0-2.3.0

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

##### 0.0.1-2.3.0

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

##### 0.0.0-2.3.0

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

## SA3

[add component documentation]

### MPS

[add component documentation]

#### TIME

[add component documentation]

##### SWITCH

[add component documentation]

###### TEST

Instance id: | SA3_MPS_TIME/SWITCH/TEST
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

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

#### BCM

[add component documentation]

##### BCM_MONITOR

### UTIL

[add component documentation]

#### LASERINT

[add component documentation]

##### SASE2

### FEL

[add component documentation]

#### PBLM

[add component documentation]

##### PBLM_MONITOR_SA2

### RF

[add component documentation]

#### LLRF_CONTROLLER

[add component documentation]

##### VS_GUN_I1

## LAS

[add component documentation]

### PPL

[add component documentation]

#### SA2XT

[add component documentation]

##### DCTRL

[add component documentation]

###### 5V_OUTPUT_1

Instance id: | LAS_PPL_SA2XT/DCTRL/5V_OUTPUT_1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-8
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Scenes: | HED_XTD6_PPU/CTRL/BPP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

## HED

[add component documentation]

### XTD6

[add component documentation]

#### CRL

[add component documentation]

##### DCTRL

[add component documentation]

###### ALL_LENSES_OUT

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

##### MDL

[add component documentation]

###### CRL

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- interlocks:
    Properties of the interlock sensors.

Release History
1.3.0-2.11.0

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

1.2.4-2.10.0

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

1.2.3-2.10.0

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

1.2.3-2.7.2

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

1.2.2-2.7.2-test

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

1.2.2-2.7.2

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

1.2.1-2.7.0-test

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

1.2.1-2.7.0

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

1.2.0-2.7.0

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

1.1.1-2.2.4-hotfix

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

1.1.1-2.2.4

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

1.1.0-2.2.4

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

1.0.3-2.2.3

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

1.0.2-2.2.3

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

1.0.1-2.1.14

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

1.0.0-2.1.14

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

##### MOTOR

[add component documentation]

###### CHAM_AX

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

###### LENS10_X

###### LENS10_Y

###### LENS1_X

###### LENS1_Y

###### LENS2_X

###### LENS2_Y

###### LENS3_X

###### LENS3_Y

###### LENS4_X

###### LENS4_Y

###### LENS5_X

###### LENS5_Y

###### LENS6_X

###### LENS6_Y

###### LENS7_X

###### LENS7_Y

###### LENS8_X

###### LENS8_Y

###### LENS9_X

###### LENS9_Y

##### SWITCH

[add component documentation]

###### LENS10_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS10_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS10_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS10_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS1_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS1_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS1_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS1_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS2_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS2_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS2_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS2_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS3_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS3_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS3_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS3_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS4_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS4_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS4_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS4_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS5_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS5_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS5_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS5_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS6_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS6_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS6_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS6_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS7_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS7_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS7_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS7_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS8_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS8_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS8_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS8_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS9_OUT1

Instance id: | HED_XTD6_CRL/SWITCH/LENS9_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS9_OUT2

Instance id: | HED_XTD6_CRL/SWITCH/LENS9_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

##### TSENS

[add component documentation]

###### LENS10_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS10_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS1_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS1_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS2_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS2_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS3_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS3_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS4_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS4_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS5_T1

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

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

4.6.0-2.11.0-rc2

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

4.6.0-2.11.0

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

4.6.0-2.11.0-rc1

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

4.4.6-2.10.0-hotfix-04

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

4.4.6-2.10.0-hotfix-03

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

4.4.6-2.10.0-hotfix-02

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

4.4.6-2.10.0-hotfix-01

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

4.5.0-2.10.0

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

4.4.6-2.10.0

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

###### LENS5_T2

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

Warning

Rogue installation which is not mentioned in the deployment!

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

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

Release History
4.8.2-2.11.1rc1

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

4.6.5-2.11.1-rc1

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

4.6.5-2.11.1

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

4.8.1-2.11.4

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

4.8.0-2.11.4

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

4.7.0-2.10.5_sa3_vacuum

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

4.6.4-2.11.1-peltier-hotfix-@SPB

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

4.6.4-2.11.1

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

4.6.3-2.11.1

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

4.6.2-2.11.0

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

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T1

Instance id: | HED_XTD6_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T2

Instance id: | HED_XTD6_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T1

Instance id: | HED_XTD6_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T2

Instance id: | HED_XTD6_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T1

Instance id: | HED_XTD6_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T2

Instance id: | HED_XTD6_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T1

Instance id: | HED_XTD6_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T2

Instance id: | HED_XTD6_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### DPXGM

[add component documentation]

##### DCTRL

[add component documentation]

###### RGA_ENABLE

Instance id: | HED_XTD6_DPXGM/DCTRL/RGA_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RGA_XTRIP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### FEEDBACK

[add component documentation]

##### MDL

[add component documentation]

###### MIRROR_FEEDBACk

###### MIRROR_2_FEEDBACK

#### HRMONO

[add component documentation]

##### ASENS

[add component documentation]

###### CRYSTAL1D

Instance id: | HED_XTD6_HRMONO/ASENS/CRYSTAL1D
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2D

Instance id: | HED_XTD6_HRMONO/ASENS/CRYSTAL2D
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_HRMONO/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_HRMONO|Pop-In0, HED_XTD6_HRMONO_Popin_compact, HED_XTD6_HRMONO|Pop-In
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_HRMONO/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | HED_XTD6_HRMONO|Pop-In0, HED_XTD6_HRMONO_Popin_compact, HED_XTD6_HRMONO/CAM/BEAMVIEW|scene, HED_XTD6_HRMONO|Pop-In, test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM

Instance id: | HED_XTD6_HRMONO/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO/CAM/BEAMVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_OUT

Instance id: | HED_XTD6_HRMONO/DCTRL/SCREEN_OUT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### CHAMBER_Y

###### CRYSTAL_AZ

###### CRYSTAL_X

###### SCREEN

###### CRYSTAL_AX

##### SWITCH

[add component documentation]

###### CRYSTAL_OUT

Instance id: | HED_XTD6_HRMONO/SWITCH/CRYSTAL_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_OUT

Instance id: | HED_XTD6_HRMONO/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

##### TSENS

[add component documentation]

###### CRYSTAL1D_TB

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL1D_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL1U_TB

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL1U_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2D_TB

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL2D_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2U_TA

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL2U_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2U_TB

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL2U_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL1D_TA

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL1D_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL1U_TA

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL1U_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2D_TA

Instance id: | HED_XTD6_HRMONO/TSENS/CRYSTAL2D_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Motion_Main_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_TA

Instance id: | HED_XTD6_HRMONO/TSENS/SCREEN_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Pop-In0, HED_XTD6_HRMONO_Popin_compact, HED_XTD6_HRMONO|Pop-In
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_TB

Instance id: | HED_XTD6_HRMONO/TSENS/SCREEN_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_HRMONO|Pop-In0, HED_XTD6_HRMONO_Popin_compact, HED_XTD6_HRMONO|Pop-In
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_HRMONO/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_HRMONO|Pop-In0, HED_XTD6_HRMONO_Popin_compact, HED_XTD6_HRMONO|Pop-In
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | HED_XTD6_HRMONO/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### VSWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | HED_XTD6_HRMONO/VSWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### IMGPI

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_IMGPI/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon82n0
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | Beam_Imagers, HED_POP-in_avg_large, HEDPop-inXTD6, HED_XTD6_IMGPI_Spot_Size, HED_XTD6_IMGPI_AVG, HED_XTD6_IMGPI_MAIN_New, HED_XTD6_IMGPI_AVG_only, dump
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_IMGPI/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | HED_POP-in_large, SA2_MAIN, Beam_Imagers, HED_XTD6_IMGPI_MAIN0, bab, SA2_MAIN, HEDPop-inXTD6, HED_XTD6_IMGPI/CAM/BEAMVIEW, HED_XTD6_IMGPI, SA2_MAIN, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI/CAM/BEAMVIEW, HED_XTD6_IMGPI_Spot_Size, HED_XTD6_IMGPI_AVG, XGM+IMGPI, HED_XTD6_IMGPI_MAIN_New, SA2_MAIN_BKR-wallpaper, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI_MAIN0, HED_XTD6_IMGPI_AVG_only, HED_XTD6_IMGPI_JITTER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | HED_XTD6_IMGPI/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | bab, HED_XTD6_IMGPI, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI_AVG_only
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | HED_XTD6_IMGPI/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | Beam_Imagers, HED_XTD6_IMGPI_MAIN0, bab, HED_XTD6_IMGPI, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI_MAIN_New, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI, HED_XTD6_IMGPI_SETUP, HED_XTD6_IMGPI_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### SCREEN_POSITION

Instance id: | HED_XTD6_IMGPI/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | Beam_Imagers, HED_XTD6_IMGPI/MDL/SCREEN_POSITION|scene, HED_XTD6_IMGPI_MAIN0, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI/MDL/SCREEN_POSITION|scene, HED_XTD6_IMGPI_MAIN_New, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI/MDL/SCREEN_POSITION|scene, HED_XTD6_IMGPI_MAIN0, HED_BEAMLINE_STATUS/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveYAG1:
    Moves the motor to the position marked with this label
- moveYAG2:
    Moves the motor to the position marked with this label
- moveDiamond_B:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_IMGPI/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon82n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | HED_PopIn_Mono, HED_XTD6_IMGPI_fitted_values, HED_XTD6_IMGPI_Spot_Size, HED_XTD6_IMGPI_AVG, XGM+IMGPI, HED_XTD6_IMGPI_MAIN_New, HED_XGM_IMG, HED_XTD6_IMGPI_MAIN, Test_correlation
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### BEAMVIEW0

Instance id: | HED_XTD6_IMGPI/PROC/BEAMVIEW0
Class id: | ImageProcessor
Host: | exflcon82n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | HED_XTD6_IMGPI/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | HED_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_BEAMLINE_STATUS/Shutdown, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | HED_XTD6_IMGPI/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### SPROC

[add component documentation]

###### BEAMVIEW

Simple Image Processor

The `SimpleImageProcessor` device is documented in simpleimageprocessor:simple-image-processor-user

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

#### MONO-1

[add component documentation]

##### CAM

[add component documentation]

###### MECHVIEW

Instance id: | HED_XTD6_MONO-1/CAM/MECHVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO-1/CAM/MECHVIEW-2|scene, HED_XTD6_MONO-1/CAM/MECHVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### MECHVIEW-2

Instance id: | HED_XTD6_MONO-1/CAM/MECHVIEW-2
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO-1/CAM/MECHVIEW-2|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### MDL

[add component documentation]

###### ACCM_PITCH

Instance id: | HED_XTD6_MONO-1/MDL/ACCM_PITCH
Class id: | MonoChromatorEnergyChanger
Host: | sa2-br-sys-con-8
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Scenes: | HED_PopIn_Mono, HED_XTD6_MONO-MDL-ACCM_PITCH, HED_XTD6_MONO_1_overview, HED-ENERGY-SCENE-MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- pitchMotor:
    FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
- proposedPosition:
    Proposed Position
- interfaces:
    Interface required for Scan tool
- interplanarSpacing:
    d-spacing: the distance between planes of atoms that give rise to diffraction
- barLength:
    Provide a Bar Length
- save:
    Save Calibrated X0 position and Actual Bragg Energy
- calibrateTarget:
    Calibrate Target
- calibrate:
    Calibrate actual position to calibrated position
- calibratedPosition:
    Calibrated Position
- calibratedBragg:
    Calibrated Bragg angle
- calibratedEnergy:
    Calibrated Energy
- offset:
    Offset
- axisInversion:
    Mirror Axis
- deltaX:
    Delta X
- deltaTheta:
    Delta Theta
- actualBraggAngle:
    Actual Bragg Angle
- targetBraggAngle:
    Target Bragg Angle
- actualEnergy:
    The actual energy, If connected, the bragg angle & motor target is automatically refreshed.
- targetEnergy:
    This is the Target energy setting.
- on:
    Turn On Motor
- findTarget:
    Calculates actuator positions for the desired bragg angle
- moveTarget:
    Drives the motor to the desired Target energy value
- stop:
    Stop monochromator motion.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

###### ACCM_PITCH_NEWMODEL

Instance id: | HED_XTD6_MONO-1/MDL/ACCM_PITCH_NEWMODEL
Class id: | MonoChromator
Host: | sa2-br-sys-con-8
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- pitchMotor:
    FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
- proposedPosition:
    Proposed Position
- barLength:
    Distance between the linear translation axis and center of rotation of long arm including direction
- conversion:
    Conversion parameter for Si111 at ambient conditions, d = qhce/4pi
- angularOffset:
    Offset. It will only be applied after calibration
- calibrate:
    Calibrate actual position to calibrated position
- calibrateTarget:
    Calibrate the target position of the monochromator. Thisaction persists the values of the calibrated energy and motor positon on disk
- calibratedPosition:
    Calibrated Position
- calibratedEnergy:
    Calibrated Energy
- translationOffset:
    Translation stage offset, Xo
- actualEnergy:
    The actual energy, If connected, motor target positionis automatically refreshed.
- targetEnergy:
    This is the Target energy setting.
- on:
    Turn On Motor
- findTarget:
    Calculates actuator positions for the desired target energy
- moveTarget:
    Drives the motor to the desired Target energy value
- stop:
    Stop monochromator motion.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | HED_XTD6_MONO-1/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MONO-2

[add component documentation]

##### MDL

[add component documentation]

###### ACCM_PITCH

Instance id: | HED_XTD6_MONO-2/MDL/ACCM_PITCH
Class id: | MonoChromatorEnergyChanger
Host: | sa2-br-sys-con-8
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/monoChromatorEnergyChanger
Last modified: | 2021-06-11T16:27:36.000+02:00
Created at: | 2018-07-19T15:59:24.000+02:00
Main authors: | Hauf, Parenti, Degon
Latest tag: | 1.6.3-2.10.0
Deployment tag: | 1.6.3-2.10.0
Scenes: | HED_PopIn_Mono, HED_XTD6_MONO-MDL-ACCM_PITCH, HED-ENERGY-SCENE-MONO-2, HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- pitchMotor:
    FXE_XTD9_MONO-1/MOTOR/ACCM_PITCH
- proposedPosition:
    Proposed Position
- interfaces:
    Interface required for Scan tool
- interplanarSpacing:
    d-spacing: the distance between planes of atoms that give rise to diffraction
- barLength:
    Provide a Bar Length
- save:
    Save Calibrated X0 position and Actual Bragg Energy
- calibrateTarget:
    Calibrate Target
- calibrate:
    Calibrate actual position to calibrated position
- calibratedPosition:
    Calibrated Position
- calibratedBragg:
    Calibrated Bragg angle
- calibratedEnergy:
    Calibrated Energy
- offset:
    Offset
- axisInversion:
    Mirror Axis
- deltaX:
    Delta X
- deltaTheta:
    Delta Theta
- actualBraggAngle:
    Actual Bragg Angle
- targetBraggAngle:
    Target Bragg Angle
- actualEnergy:
    The actual energy, If connected, the bragg angle & motor target is automatically refreshed.
- targetEnergy:
    This is the Target energy setting.
- on:
    Turn On Motor
- findTarget:
    Calculates actuator positions for the desired bragg angle
- moveTarget:
    Drives the motor to the desired Target energy value
- stop:
    Stop monochromator motion.

Release History
1.6.3-2.10.0

Created: | 2021-06-11T12:41:03.000+02:00
Author: | Wajid Ehsan
Notes: | Fix actual energy

1.6.2-2.10.0

Created: | 2020-11-23T12:26:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.6.1-2.9.0

Created: | 2020-09-11T13:09:42.000+02:00
Author: | Wajid Ehsan
Notes: |

1.6.0-2.6.0

Created: | 2019-09-03T16:31:18.000+02:00
Author: | Dennis Goeries
Notes: |

1.5.0-2.5.0

Created: | 2019-08-28T14:38:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.4.1-2.4.0

Created: | 2019-06-20T18:05:38.000+02:00
Author: | Wajid Ehsan
Notes: | Device generated scene

1.4.0-2.4.0

Created: | 2019-06-13T19:06:55.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of relative geometry as a new class

1.3.1-2.4.0

Created: | 2019-04-25T13:18:28.000+02:00
Author: | Wajid Ehsan
Notes: | Get actual position from master motor

1.3.0-2.4.0

Created: | 2019-04-08T13:42:45.000+02:00
Author: | Wajid Ehsan
Notes: | Integration of monochromator group with a scan tool

1.2.0-2.3.1

Created: | 2019-03-20T16:02:17.000+01:00
Author: | Wajid Ehsan
Notes: | Save data in a permanent directory

1.1.0-2.2.5

Created: | 2019-01-07T16:03:45.000+01:00
Author: | Wajid Ehsan
Notes: |

1.0.0-2.2.5

Created: | 2018-11-13T18:02:28.000+01:00
Author: | Wajid Ehsan
Notes: |

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | HED_XTD6_MONO-2/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MONO1

[add component documentation]

Danger

Known fault

The HED_XTD6_MONO1/SWITCH/TO_XTAL_ROLL_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO1/SWITCH/TO_XTAL_RPITCH_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO2/SWITCH/TO_XTAL_ROLL_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO2/SWITCH/TO_XTAL_RPITCH_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

##### ACTRL

[add component documentation]

###### HT1_I_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT1_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT1_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT2_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT2_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT3_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_PROG

Instance id: | HED_XTD6_MONO1/ACTRL/HT3_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | HED_XTD6_MONO1/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO_1_overview, HED_XTD6_MONO1/ACTRL/TOP_XTAL_FPITCH|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### HT1_I_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT1_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT1_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT2_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT2_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT3_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_MON

Instance id: | HED_XTD6_MONO1/ASENS/HT3_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | HED_XTD6_MONO1/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO1/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO1/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-8
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO1/CAM/BEAMVIEW|scene, HED_XTD6_MONO-1/CAM/BEAMVIEW, HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM

Instance id: | HED_XTD6_MONO1/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1/CAM/BEAMVIEW, HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO

Instance id: | HED_XTD6_MONO1/DCTRL/CRYO
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature0_Mono1, Temperature_control, HED_XTD6_MONO1_TMPCTRL, VS22060_VS22070_VS22080, HED_XTD6_MONO_1_overview, VS22060_VS22070_VS22080__OLD, HED-MONO-TEMP, HED-MONO-TEMP_OLD, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080_OLD, HED-MONO-TEMP, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, EventonOCT06_21
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_ENABLE

Instance id: | HED_XTD6_MONO1/DCTRL/HT1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL, HED_XTD6_MONO_1_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_REM_SEL

Instance id: | HED_XTD6_MONO1/DCTRL/HT1_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_ENABLE

Instance id: | HED_XTD6_MONO1/DCTRL/HT2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL, HED_XTD6_MONO_1_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_REM_SEL

Instance id: | HED_XTD6_MONO1/DCTRL/HT2_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_ENABLE

Instance id: | HED_XTD6_MONO1/DCTRL/HT3_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control, HED_XTD6_MONO1_TMPCTRL, HED_XTD6_MONO_1_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_REM_SEL

Instance id: | HED_XTD6_MONO1/DCTRL/HT3_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED

###### TOP_XTAL_ROLL_LIDLE

Instance id: | HED_XTD6_MONO1/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1/CAM/MECHVIEW-2|scene, HED_XTD6_MONO-1, HED_XTD6_MONO_1_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_ON

Instance id: | HED_XTD6_MONO1/DCTRL/TOP_XTAL_ROLL_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1/CAM/MECHVIEW-2|scene, HED_XTD6_MONO-1, HED_XTD6_MONO_1_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | HED_XTD6_MONO1/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1, HED_XTD6_MONO_1_overview, HED_XTD6_MONO-1/CAM/MECHVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_ON

Instance id: | HED_XTD6_MONO1/DCTRL/TOP_XTAL_RPITCH_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1, HED_XTD6_MONO_1_overview, HED_XTD6_MONO-1/CAM/MECHVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### ACCM_PITCH

###### TOP_XTAL_ROLL

Instance id: | HED_XTD6_MONO1/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-1/CAM/MECHVIEW-2|scene, HED_XTD6_MONO_1_overview, HED_XTD6_MONO1/MOTOR/TOP_XTAL_ROLL|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH

Instance id: | HED_XTD6_MONO1/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO_1_overview, HED_XTD6_MONO1/MOTOR/TOP_XTAL_RPITCH|motorScene, HED_XTD6_MONO-1/CAM/MECHVIEW|scene, HED_XTD6_HRMONO|Pop-In
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TX

###### TY

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_MONO-1_AVG, HED_XTD6_MONO-1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### HT1_IS_LOC

Instance id: | HED_XTD6_MONO1/SWITCH/HT1_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_IS_LOC

Instance id: | HED_XTD6_MONO1/SWITCH/HT2_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_IS_LOC

Instance id: | HED_XTD6_MONO1/SWITCH/HT3_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_LFAULT

Instance id: | HED_XTD6_MONO1/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_TEMP

Instance id: | HED_XTD6_MONO1/SWITCH/TOP_XTAL_ROLL_TEMP
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | HED_XTD6_MONO1/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_TEMP

Instance id: | HED_XTD6_MONO1/SWITCH/TOP_XTAL_RPITCH_TEMP
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

##### TSENS

[add component documentation]

###### PT1

Instance id: | HED_XTD6_MONO1/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature0_Mono1, HED_XTD6_MONO1_TMPCTRL, HED_XTD6_MONO_1_overview, HED-MONO-TEMP, HED-MONO-TEMP_OLD, Temp_HED_dfm, Temp_HED_dfm, HED-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT2

Instance id: | HED_XTD6_MONO1/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature0_Mono1, HED_XTD6_MONO1_TMPCTRL, HED_XTD6_MONO_1_overview, HED-MONO-TEMP, HED-MONO-TEMP_OLD, Temp_HED_dfm, Temp_HED_dfm, HED-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT3

Instance id: | HED_XTD6_MONO1/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Temperature0_Mono1, HED_XTD6_MONO1_TMPCTRL, VS22060_VS22070_VS22080, HED_XTD6_MONO_1_overview, VS22060_VS22070_VS22080__OLD, HED-MONO-TEMP, HED-MONO-TEMP_OLD, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080_OLD, Temp_HED_dfm, Temp_HED_dfm, HED-MONO-TEMP, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### MONO2

[add component documentation]

Danger

Known fault

The HED_XTD6_MONO1/SWITCH/TO_XTAL_ROLL_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO1/SWITCH/TO_XTAL_RPITCH_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO2/SWITCH/TO_XTAL_ROLL_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

Danger

Known fault

The HED_XTD6_MONO2/SWITCH/TO_XTAL_RPITCH_TEMP temperature sensor is erroneously connected to a SWITCH terminal. This makes the sensor unusable, but more importantly can lead to message spamming of the system. This device is to stay off all the time.

##### ACTRL

[add component documentation]

###### HT1_I_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT1_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT1_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT2_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT2_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT3_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_PROG

Instance id: | HED_XTD6_MONO2/ACTRL/HT3_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperature_control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | HED_XTD6_MONO2/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO_2_overview, HED_XTD6_MONO2/ACTRL/TOP_XTAL_FPITCH|scene, HED_XTD6_MONO2/ACTRL/TOP_XTAL_FPITCH|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### HT1_I_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT1_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT1_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT2_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT2_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT3_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_MON

Instance id: | HED_XTD6_MONO2/ASENS/HT3_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | HED_XTD6_MONO2/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO2/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_MONO-2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO2/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-8
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO2/CAM/BEAMVIEW|scene, HED_XTD6_MONO-2/CAM/BEAMVIEW, HED_XTD6_MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### MECHVIEW

Instance id: | HED_XTD6_MONO2/CAM/MECHVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO2/CAM/MECHVIEW|scene, HED_XTD6_MONO2/CAM/MECHVIEW-2|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### MECHVIEW-2

Instance id: | HED_XTD6_MONO2/CAM/MECHVIEW-2
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-5
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_MONO2/CAM/MECHVIEW-2|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM

Instance id: | HED_XTD6_MONO2/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO-2/CAM/BEAMVIEW, HED_XTD6_MONO-2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO

Instance id: | HED_XTD6_MONO2/DCTRL/CRYO
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, VS22060_VS22070_VS22080, Temperature0_Mono2, HED_XTD6_MONO_2_overview, VS22060_VS22070_VS22080__OLD, HED-MONO-TEMP, HED-MONO-TEMP_OLD, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080_OLD, HED-MONO-TEMP, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, EventonOCT06_21
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_ENABLE

Instance id: | HED_XTD6_MONO2/DCTRL/HT1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_REM_SEL

Instance id: | HED_XTD6_MONO2/DCTRL/HT1_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_ENABLE

Instance id: | HED_XTD6_MONO2/DCTRL/HT2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_REM_SEL

Instance id: | HED_XTD6_MONO2/DCTRL/HT2_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_ENABLE

Instance id: | HED_XTD6_MONO2/DCTRL/HT3_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_REM_SEL

Instance id: | HED_XTD6_MONO2/DCTRL/HT3_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED

###### TOP_XTAL_ROLL_LIDLE

Instance id: | HED_XTD6_MONO2/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_ON

Instance id: | HED_XTD6_MONO2/DCTRL/TOP_XTAL_ROLL_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO_2_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | HED_XTD6_MONO2/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_ON

Instance id: | HED_XTD6_MONO2/DCTRL/TOP_XTAL_RPITCH_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### ACCM_PITCH

###### TOP_XTAL_ROLL

Instance id: | HED_XTD6_MONO2/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2/MOTOR/TOP_XTAL_ROLL|motorScene, HED_XTD6_MONO_2_overview, HED_XTD6_MONO2/MOTOR/TOP_XTAL_ROLL|simpleMotorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH

Instance id: | HED_XTD6_MONO2/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_PopIn_Mono, HED_XTD6_MONO_2_overview, HED_XTD6_MONO2/MOTOR/TOP_XTAL_RPITCH|motorScene, HED_XTD6_MONO2/MOTOR/TOP_XTAL_RPITCH|simpleMotorScene, HED_XTD6_MONO2/MOTOR/TOP_XTAL_RPITCH|simpleMotorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TX

###### TY

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | HED_XTD6_MONO2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_XTD6_MONO-2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### HT1_IS_LOC

Instance id: | HED_XTD6_MONO2/SWITCH/HT1_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_IS_LOC

Instance id: | HED_XTD6_MONO2/SWITCH/HT2_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_IS_LOC

Instance id: | HED_XTD6_MONO2/SWITCH/HT3_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_LFAULT

Instance id: | HED_XTD6_MONO2/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_TEMP

Instance id: | HED_XTD6_MONO2/SWITCH/TOP_XTAL_ROLL_TEMP
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | HED_XTD6_MONO2/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_TEMP

Instance id: | HED_XTD6_MONO2/SWITCH/TOP_XTAL_RPITCH_TEMP
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

##### TSENS

[add component documentation]

###### PT1

Instance id: | HED_XTD6_MONO2/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperatures_HED_mono2_dfm, Temperature0_Mono2, HED_XTD6_MONO_2_overview, HED-MONO-TEMP, HED-MONO-TEMP_OLD, HED-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT2

Instance id: | HED_XTD6_MONO2/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperatures_HED_mono2_dfm, Temperature0_Mono2, HED_XTD6_MONO_2_overview, HED-MONO-TEMP, HED-MONO-TEMP_OLD, HED-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT3

Instance id: | HED_XTD6_MONO2/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_MONO2_TMPCTRL, Temperatures_HED_mono2_dfm, VS22060_VS22070_VS22080, Temperature0_Mono2, HED_XTD6_MONO_2_overview, VS22060_VS22070_VS22080__OLD, HED-MONO-TEMP, HED-MONO-TEMP_OLD, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080_OLD, HED-MONO-TEMP, VS22060_VS22070_VS22080, VS22060_VS22070_VS22080
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### PBLM-2

[add component documentation]

##### TPF

[add component documentation]

###### L

Instance id: | HED_XTD6_PBLM-2/TPF/L
Class id: | TwoPeakFinder
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Two Peak Finder

The `TwoPeakFinder` device is part of the imageProcessor package, and is documented in imageprocessor:image-two-peak-finder-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.
- zeroPoint:
    The device will try to find a peak left, and a peak right, from this point.
- threshold:
    TODO - currently unused
- roi:
    The user-defined region of interest (ROI), specified as [lowX, highX]. [0, 0] will be interpreted as ‘whole range’.
- peak1Value:
    Amplitude of the 1st peak.
- peak1Position:
    Position of the 1st peak.
- peak1Fwhm:
    FWHM of the 1st peak.
- peak2Value:
    Amplitude of the 2nd peak.
- peak2Position:
    Position of the 2nd peak.
- peak2Fwhm:
    FWHM of the 2nd peak.
- peakRatio:
    Amplitude of the 1st peak divided by amplitude of the second peak.

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.

###### R

Instance id: | HED_XTD6_PBLM-2/TPF/R
Class id: | TwoPeakFinder
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Two Peak Finder

The `TwoPeakFinder` device is part of the imageProcessor package, and is documented in imageprocessor:image-two-peak-finder-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.
- zeroPoint:
    The device will try to find a peak left, and a peak right, from this point.
- threshold:
    TODO - currently unused
- roi:
    The user-defined region of interest (ROI), specified as [lowX, highX]. [0, 0] will be interpreted as ‘whole range’.
- peak1Value:
    Amplitude of the 1st peak.
- peak1Position:
    Position of the 1st peak.
- peak1Fwhm:
    FWHM of the 1st peak.
- peak2Value:
    Amplitude of the 2nd peak.
- peak2Position:
    Position of the 2nd peak.
- peak2Fwhm:
    FWHM of the 2nd peak.
- peakRatio:
    Amplitude of the 1st peak divided by amplitude of the second peak.

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.

#### PBLM

[add component documentation]

##### AVG

[add component documentation]

###### L

Instance id: | HED_XTD6_PBLM/AVG/L
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | HED_Overview0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### R

Instance id: | HED_XTD6_PBLM/AVG/R
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM_RIGHT0, HED_Overview0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### R0

Instance id: | HED_XTD6_PBLM/AVG/R0
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM_RIGHT0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### L

Instance id: | HED_XTD6_PBLM/CAM/L
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | CAM_LEFT, HED_Overview, HED_Overview0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### R

Instance id: | HED_XTD6_PBLM/CAM/R
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_Overview, CAM_RIGHT, CAM_RIGHT0, HED_Overview0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER_LEFT

Instance id: | HED_XTD6_PBLM/DCTRL/CAM_POWER_LEFT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CAM_LEFT, HED_Overview, HED_Overview0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_POWER_RIGHT

Instance id: | HED_XTD6_PBLM/DCTRL/CAM_POWER_RIGHT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_Overview, CAM_RIGHT, CAM_RIGHT0, HED_Overview0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### ALARM

Instance id: | HED_XTD6_PBLM/MDL/ALARM
Class id: | GenericEstimator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

##### MOTOR

[add component documentation]

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### PROC

[add component documentation]

###### L

Instance id: | HED_XTD6_PBLM/PROC/L
Class id: | ImageProcessor
Host: | exflcon196
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM_LEFT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SPROC

[add component documentation]

###### R

Simple Image Processor

The `SimpleImageProcessor` device is documented in simpleimageprocessor:simple-image-processor-user

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

##### SWITCH

[add component documentation]

###### COLLISION_HOR

Instance id: | HED_XTD6_PBLM/SWITCH/COLLISION_HOR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### COLLISION_VER

Instance id: | HED_XTD6_PBLM/SWITCH/COLLISION_VER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TPF

[add component documentation]

###### L

Instance id: | HED_XTD6_PBLM/TPF/L
Class id: | TwoPeakFinder
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Two Peak Finder

The `TwoPeakFinder` device is part of the imageProcessor package, and is documented in imageprocessor:image-two-peak-finder-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.
- zeroPoint:
    The device will try to find a peak left, and a peak right, from this point.
- threshold:
    TODO - currently unused
- roi:
    The user-defined region of interest (ROI), specified as [lowX, highX]. [0, 0] will be interpreted as ‘whole range’.
- peak1Value:
    Amplitude of the 1st peak.
- peak1Position:
    Position of the 1st peak.
- peak1Fwhm:
    FWHM of the 1st peak.
- peak2Value:
    Amplitude of the 2nd peak.
- peak2Position:
    Position of the 2nd peak.
- peak2Fwhm:
    FWHM of the 2nd peak.
- peakRatio:
    Amplitude of the 1st peak divided by amplitude of the second peak.

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.

###### R

Instance id: | HED_XTD6_PBLM/TPF/R
Class id: | TwoPeakFinder
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Two Peak Finder

The `TwoPeakFinder` device is part of the imageProcessor package, and is documented in imageprocessor:image-two-peak-finder-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.
- zeroPoint:
    The device will try to find a peak left, and a peak right, from this point.
- threshold:
    TODO - currently unused
- roi:
    The user-defined region of interest (ROI), specified as [lowX, highX]. [0, 0] will be interpreted as ‘whole range’.
- peak1Value:
    Amplitude of the 1st peak.
- peak1Position:
    Position of the 1st peak.
- peak1Fwhm:
    FWHM of the 1st peak.
- peak2Value:
    Amplitude of the 2nd peak.
- peak2Position:
    Position of the 2nd peak.
- peak2Fwhm:
    FWHM of the 2nd peak.
- peakRatio:
    Amplitude of the 1st peak divided by amplitude of the second peak.

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]

###### BLADE_BOTTOM

Instance id: | HED_XTD6_PBLM/TSENS/BLADE_BOTTOM
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT

Instance id: | HED_XTD6_PBLM/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT

Instance id: | HED_XTD6_PBLM/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP

Instance id: | HED_XTD6_PBLM/TSENS/BLADE_TOP
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### L_TRIGGER

Instance id: | HED_XTD6_PBLM/TSYS/L_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### R_TRIGGER

Instance id: | HED_XTD6_PBLM/TSYS/R_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### 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.

##### 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_POW

Instance id: | HED_XTD6_PPU/CAM/CAMERA_POW
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DISKVIEW

Instance id: | HED_XTD6_PPU/CAM/DISKVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0, HED_XTD6_PPU/CAM/DISKVIEW|scene, SA2_XTD6_VAC-RGA-DPS_DS_TEMP_PPU_RVG_Control, HED_XTD6_PPU/PulseOnDemandExpert, HED_XTD6_PPU/SimpleView, HED_XTD6_PPU/SimpleViewNewMDL
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

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

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[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.

###### BARRIER1_RX

Instance id: | HED_XTD6_PPU/DCTRL/BARRIER1_RX
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0, HED_XTD6_PPU/CTRL/BPP, HED_XTD6_PPU/PulseOnDemandExpert, HED_XTD6_PPU/LightBarrier
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BARRIER2_RX

Instance id: | HED_XTD6_PPU/DCTRL/BARRIER2_RX
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0, HED_XTD6_PPU/CTRL/BPP, HED_XTD6_PPU/PulseOnDemandExpert, HED_XTD6_PPU/LightBarrier
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BARRIER_RX_POW

Instance id: | HED_XTD6_PPU/DCTRL/BARRIER_RX_POW
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0, HED_XTD6_PPU/CTRL/BPP, HED_XTD6_PPU/PulseOnDemandExpert
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED

Instance id: | HED_XTD6_PPU/DCTRL/LED
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### STEP1

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.

###### STEP2

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: | HED_XTD6_PPU/DCTRL/TRIG
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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’]!

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
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” 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: |

##### 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: | HED_XTD6_PPU/ENC/ROTOR
Class id: | BeckhoffEncoder
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

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.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

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: | HED_XTD6_PPU/MOTOR/ROTOR
Class id: | BeckhoffSimpleMotor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/MOTOR/ROTOR|simpleMotorScene, HED_XTD6_PPU/CTRL/BPP, SA2_XTD6_VAC-RGA-DPS_DS_TEMP_PPU_RVG_Control, test, SA2_XTD6_VAC-RGA-DPS_DS_TEMP_PPU_Summary, HED_XTD6_PPU/PulseOnDemandExpert
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffSimpleMotor Documentation

The `BeckhoffSimpleMotor` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The underlying PLC soft device, `SD_Stepper` (aliased to `SD_SIMPLEMOTOR`), is documented at this location.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- off:
    Switch motor current Off.
- on:
    Switch motor current On.
- stop:
    Instructs the device to switch on and stopped.
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- offset:
    Offset will be added to encoder position.
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PROC

[add component documentation]

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.

###### DISKVIEW

Instance id: | HED_XTD6_PPU/PROC/DISKVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

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
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### EXECUTE_ONTRAIN1

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.

###### EXECUTE_ONTRAIN2

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.

###### EXECUTE_ONTRAIN3

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.

##### 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

Instance id: | HED_XTD6_PPU/TEMP/IRTHERMO
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

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.

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### IRTHERMO_POW

Instance id: | HED_XTD6_PPU/TEMP/IRTHERMO_POW
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_PPU/OVERVIEW, HED_XTD6_PPU/CAM/DISKVIEW_big_image|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### 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.

###### CAM_TRIGGER

Instance id: | HED_XTD6_PPU/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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)
- 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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### 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.

###### PPU_TRIG

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_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.

#### SDLBM-1

[add component documentation]

##### CAM

[add component documentation]

###### CAMERA

Instance id: | HED_XTD6_SDLBM-1/CAM/CAMERA
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_SDLBM-1/CAM/CAMERA|scene, HED_XTD6_SDLBM-1/CAM/CAMERA|scene, test, HED_XTD6_SDLBM-1_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | HED_XTD6_SDLBM-1/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### SCREEN

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | HED_XTD6_SDLBM-1/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | HED_XTD6_SDLBM-1/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### SDLBM-2

[add component documentation]

##### CAM

[add component documentation]

###### CAMERA

Instance id: | HED_XTD6_SDLBM-2/CAM/CAMERA
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | HED_XTD6_SDLBM-2/CAM/CAMERA|scene, HED_XTD6_SDLBM-2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | HED_XTD6_SDLBM-2/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### SCREEN

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | HED_XTD6_SDLBM-2/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | HED_XTD6_SDLBM-2/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### SDU

[add component documentation]

##### SWITCH

[add component documentation]

###### SDU_OUT_1

Instance id: | HED_XTD6_SDU/SWITCH/SDU_OUT_1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SDU_OUT_2

Instance id: | HED_XTD6_SDU/SWITCH/SDU_OUT_2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SDU_OUT_3

Instance id: | HED_XTD6_SDU/SWITCH/SDU_OUT_3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SDU_OUT_4

Instance id: | HED_XTD6_SDU/SWITCH/SDU_OUT_4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### SHUT

[add component documentation]

##### DCTRL

[add component documentation]

###### ACLOSED

Instance id: | HED_XTD6_SHUT/DCTRL/ACLOSED
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | HED_XTD6_SHUT/DCTRL/AOPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### ACLOSED

Instance id: | HED_XTD6_SHUT/SWITCH/ACLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, MPS_TEST, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VS22100, VAC_TO_MPS_USER_OLD, VS22100_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | HED_XTD6_SHUT/SWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, VS22100_HED_OLD, SA2_EPS2MPS, VAC_TO_MPS_EXPERT, SA2_MAIN, MPS_TEST, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VS22100_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VS22100, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER_OLD, VS22100, VS22100_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, HED_BEAMLINE_STATUS/Shutdown, VS22100_HED, VS22100_HED, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER, VS22100_HED
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WATER

Instance id: | HED_XTD6_SHUT/SWITCH/WATER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### T1

Instance id: | HED_XTD6_SHUT/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | HED_XTD6_SHUT/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T3

Instance id: | HED_XTD6_SHUT/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T4

Instance id: | HED_XTD6_SHUT/TSENS/T4
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VSWITCH

[add component documentation]

###### AOPEN

Instance id: | HED_XTD6_SHUT/VSWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### WATCHDOG

[add component documentation]

##### MDL

[add component documentation]

###### DIAMOND_IMGPI

Instance id: | HED_XTD6_WATCHDOG/MDL/DIAMOND_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### YAG_IMGPI

Instance id: | HED_XTD6_WATCHDOG/MDL/YAG_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_XTD6_IMGPI_MAIN, HED_XTD6_IMGPI_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### BeamPosition_IMGPI

Instance id: | HED_XTD6_WATCHDOG/MDL/BeamPosition_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-06-30T17:55:32.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Hauf, Mamchykd, Haufs
Latest tag: | 1.10.6-2.11.1
Deployment tag: | 1.10.6-2.11.1
Scenes: | HED_XTD6_IMGPI_MAIN
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.6-2.11.1

Created: | 2021-06-24T12:35:44.000Z
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

###### AVG_IMGPI_1

###### AVG_IMGPI_2

###### BEAM_POSITION_IMGPI_1

Instance id: | HED_XTD6_WATCHDOG/MDL/BEAM_POSITION_IMGPI_1
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### BEAM_POSITION_IMGPI_2

Instance id: | HED_XTD6_WATCHDOG/MDL/BEAM_POSITION_IMGPI_2
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | HED_XTD6_IMGPI_MAIN, temp
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

### OPT

[add component documentation]

#### VAC

[add component documentation]

##### SWITCH

[add component documentation]

###### GV_1_OPEN

Instance id: | HED_OPT_VAC/SWITCH/GV_1_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SIGNALS_FROM_INSTRUMENTS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### IP_TRPIPE_1_ON_SP

Instance id: | HED_OPT_VAC/SWITCH/IP_TRPIPE_1_ON_SP
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SIGNALS_FROM_INSTRUMENTS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### IP_TRPIPE_2_ON_SP

Instance id: | HED_OPT_VAC/SWITCH/IP_TRPIPE_2_ON_SP
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SIGNALS_FROM_INSTRUMENTS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

### TOEPS

[add component documentation]

#### PILC1

[add component documentation]

##### VSWITCH

[add component documentation]

###### EXP_BS_ABS_CLOSED

Instance id: | HED_TOEPS_PILC1/VSWITCH/EXP_BS_ABS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EXP_BS_ABS_OPEN

Instance id: | HED_TOEPS_PILC1/VSWITCH/EXP_BS_ABS_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPT_BS_ABS_CLOSED

Instance id: | HED_TOEPS_PILC1/VSWITCH/OPT_BS_ABS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPT_BS_ABS_OPEN

Instance id: | HED_TOEPS_PILC1/VSWITCH/OPT_BS_ABS_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

## MID

[add component documentation]

### XTD6

[add component documentation]

#### ATT

[add component documentation]

##### MDL

[add component documentation]

###### ATT

Instance id: | MID_XTD6_ATT/MDL/ATT
Class id: | JJAttenuator
Host: | sa2-br-sys-con-1
Class documentation:
| JJAttenuator
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/jjAttenuator
Last modified: | 2021-05-20T14:35:28.000+02:00
Created at: | 2016-12-22T15:35:45.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 2.5.3-2.11.0
Deployment tag: | 2.5.3-2.11.0
Scenes: | MID_XTD6_ATT/MDL/ATT|buttonScene, SA2_MAIN, SA2_MAIN_BKR-wallpaper, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- desiredTransmission:
    Provide a desired transmission value between 0 and 1
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an attenuator table was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current attenuator setting and target is automatically refreshed.
- posConfigRod1:
    The position configuration used by the attenuator for Rod 1. Can be only set before instantiation.
- posConfigRod2:
    The position configuration used by the attenuator for Rod 2. Can be only set before instantiation.
- posConfigRod3:
    The position configuration used by the attenuator for Rod 3. Can be only set before instantiation.
- posConfigRod4:
    The position configuration used by the attenuator for Rod 4. Can be only set before instantiation.
- positionTolerance:
    Position tolerance to identify material foils
- availableScenes:
    Scenes from the Attenuator System
- useSafeConfiguration:
    It ensures that at least one absorber on the arm of type diamond is inserted into the beam from upstream Arm(rod)
- upstreamRod:
    Select upstream rod, it can be either 1 or 4
- findTarget:
    Calculates motor positions and attenuator information for the desired transmission
- moveTarget:
    Move to target setting
- moveRod1_0:
    Rod1 0
- moveRod1_1:
    Rod1 1
- moveRod1_2:
    Rod1 2
- moveRod1_3:
    Rod1 3
- moveRod1_4:
    Rod1 4
- moveRod1_5:
    Rod1 5
- moveRod1_6:
    Rod1 6
- moveRod2_0:
    Rod2 0
- moveRod2_1:
    Rod2 1
- moveRod2_2:
    Rod2 2
- moveRod2_3:
    Rod2 3
- moveRod2_4:
    Rod2 4
- moveRod2_5:
    Rod2 5
- moveRod2_6:
    Rod2 6
- moveRod3_0:
    Rod3 0
- moveRod3_1:
    Rod3 1
- moveRod3_2:
    Rod3 2
- moveRod3_3:
    Rod3 3
- moveRod3_4:
    Rod3 4
- moveRod3_5:
    Rod3 5
- moveRod3_6:
    Rod3 6
- moveRod4_0:
    Rod4 0
- moveRod4_1:
    Rod4 1
- moveRod4_2:
    Rod4 2
- moveRod4_3:
    Rod4 3
- moveRod4_4:
    Rod4 4
- moveRod4_5:
    Rod4 5
- moveRod4_6:
    Rod4 6

Release History
2.5.3-2.11.0

Created: | 2021-05-20T12:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Use async/await syntax

2.5.2-2.10.0

Created: | 2021-02-05T13:32:28.000+01:00
Author: | Wajid Ehsan
Notes: | Protection of SI filters in ATT stacks

2.5.1-2.10.0

Created: | 2020-11-23T11:02:21.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add CI

2.5.0-2.10.0

Created: | 2020-11-19T15:38:10.000+01:00
Author: | Dennis Goeries
Notes: |

2.4.0-2.6.1

Created: | 2019-02-12T13:41:03.000+01:00
Author: | xctrl
Notes: |

2.4.0.post2-2.2.6

Created: | 2018-11-07T18:18:58.000+01:00
Author: | silenzi
Notes: | This version will be loadable from a 2.2 system

2.4.0-2.3.0

Created: | 2018-10-23T18:08:33.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.3.1-2.2.4

Created: | 2018-07-31T16:24:49.000+02:00
Author: | Dennis Goeries
Notes: |

2.3.0-2.2.4

Created: | 2018-06-13T15:51:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.2-2.2.3

Created: | 2018-05-03T14:37:48.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.1-2.2.3

Created: | 2018-04-27T11:01:33.000+02:00
Author: | Dennis Goeries
Notes: |

2.2.0-2.2.3

Created: | 2018-04-18T17:39:22.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.0-2.2.0

Created: | 2017-12-15T17:44:24.000+01:00
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.14

Created: | 2017-09-11T17:37:46.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.14

Created: | 2017-09-04T18:00:19.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.14

Created: | 2017-08-18T16:30:01.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.14

Created: | 2017-08-16T17:34:40.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.12

Created: | 2017-07-21T17:30:30.000+02:00
Author: | Dennis Goeries
Notes: |

2.0.2-2.1

Created: | 2017-07-05T17:31:01.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CHAM_X

###### CHAM_Y

###### ROD1_IN_OUT

###### ROD2_IN_OUT

###### ROD3_IN_OUT

###### ROD4_IN_OUT

##### TSENS

[add component documentation]

###### B4C_TEMP1

Instance id: | MID_XTD6_ATT/TSENS/B4C_TEMP1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/att_main, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### B4C_TEMP2

Instance id: | MID_XTD6_ATT/TSENS/B4C_TEMP2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD1_TEMP1

Instance id: | MID_XTD6_ATT/TSENS/ROD1_TEMP1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/att_main, MID_XTD6_CRL|scene, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD1_TEMP2

Instance id: | MID_XTD6_ATT/TSENS/ROD1_TEMP2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD2_TEMP1

Instance id: | MID_XTD6_ATT/TSENS/ROD2_TEMP1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/att_main, MID_XTD6_CRL|scene, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD2_TEMP2

Instance id: | MID_XTD6_ATT/TSENS/ROD2_TEMP2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD3_TEMP1

Instance id: | MID_XTD6_ATT/TSENS/ROD3_TEMP1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/att_main, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD3_TEMP2

Instance id: | MID_XTD6_ATT/TSENS/ROD3_TEMP2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD4_TEMP1

Instance id: | MID_XTD6_ATT/TSENS/ROD4_TEMP1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_ATT/att_main, MID_XTD6_ATT/main
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ROD4_TEMP2

Instance id: | MID_XTD6_ATT/TSENS/ROD4_TEMP2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### BMPI-1

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-1/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon82n0
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | MID_XTD6_BMPI-1/CAM/BEAMVIEW|scene_New, MID_XTD6_BMPI-1_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-1/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | MID_XTD6_BMPI-1/CAM/BEAMVIEW, MID_XTD6_BMPI-1/CAM/BEAMVIEW|scene, MID_XTD6_BMPI-1/CAM/BEAMVIEW|scene_New, SA2_MAIN, SA2_MAIN_BKR-wallpaper, MID_XTD6_BMPI-1_AVG
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | MID_XTD6_BMPI-1/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, MID_XTD6_BMPI-1/CAM/BEAMVIEW|scene, MID_XTD6_BMPI-1/CAM/BEAMVIEW|scene_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | MID_XTD6_BMPI-1/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

##### MOTOR

[add component documentation]

###### FILTER

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon82n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | Beam_POSITION, MID_XTD6_BMPI-1_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### DECELERATE

Instance id: | MID_XTD6_BMPI-1/SWITCH/DECELERATE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_OUT

Instance id: | MID_XTD6_BMPI-1/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | MID_XTD6_BMPI-1/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### BMPI-2

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-2/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon82n0
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | MID_XTD6_BMPI-2_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-2/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | MID_XTD6_BMPI-2/CAM/BEAMVIEW, MID_XTD6_BMPI-2/CAM/BEAMVIEW|scene, MID_XTD6_BMPI-2_AVG
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | MID_XTD6_BMPI-2/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN, SA2_MAIN_BKR-wallpaper, MID_XTD6_BMPI-2/CAM/BEAMVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | MID_XTD6_BMPI-2/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

##### MOTOR

[add component documentation]

###### FILTER

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_BMPI-2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon82n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | Beam_POSITION, MID_XTD6_BMPI-2_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### DECELERATE

Instance id: | MID_XTD6_BMPI-2/SWITCH/DECELERATE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_OUT

Instance id: | MID_XTD6_BMPI-2/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | MID_XTD6_BMPI-2/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### CRL

[add component documentation]

##### DCTRL

[add component documentation]

###### ALL_LENSES_OUT

Instance id: | MID_XTD6_CRL/DCTRL/ALL_LENSES_OUT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### CRL

Instance id: | MID_XTD6_CRL/MDL/CRL
Class id: | CompoundRefractiveLens
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/compoundRefractiveLens
Last modified: | 2021-05-27T15:24:47.000+02:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.3.0-2.11.0
Deployment tag: | 1.3.0-2.11.0
Scenes: | MID_XTD6_CRL/MDL/CRL_TEST|scene, MID_XTD6_CRL-MDL-CRL-scene-simple, MID_XTD6_CRL/MDL/CRL|scene, MID_XTD6_CRL-MDL-CRL-scene-simple, MID_XTD6_CRL-alignLenses, MID_XTD6_CRL-MDL-CRL-scene-really-simple
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- interlocks:
    Properties of the interlock sensors.

Release History
1.3.0-2.11.0

Created: | 2021-05-27T15:25:24.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.4-2.10.0

Created: | 2021-05-26T15:39:43.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor use EPS logic

1.2.3-2.10.0

Created: | 2020-11-23T18:18:18.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T17:04:07.000+01:00
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T15:04:45.000+01:00
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T13:21:31.000+01:00
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T16:08:12.000+01:00
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T14:50:06.000+01:00
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T11:54:51.000+01:00
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T22:49:17.000+02:00
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T11:58:18.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T16:56:11.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T13:46:49.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T13:28:02.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T20:01:36.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T16:52:56.000+02:00
Author: | Dennis Goeries
Notes: |

###### CRL_TEST

Instance id: | MID_XTD6_CRL/MDL/CRL_TEST
Class id: | CompoundRefractiveLens
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/compoundRefractiveLens
Last modified: | 2020-11-23T18:18:12.000+01:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.2.3-2.10.0
Deployment tag: | 1.2.3-2.10.0
Scenes: | MID_XTD6_CRL/MDL/CRL_TEST|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- interlocks:
    Properties of the interlock sensors.
- configurationName:
    Name of configuration to create. If blank, this will default to saving numerically. If this configuration already exists, the existing one will be overwritten. Do not use the name ‘master’, it is protected. Restrict to alphanumeric characters, and do not start with a number.
- createConfiguration:
    Create a new configuration with the given name, and creates slots to save and load parameters of this configuration. In addition, saves the current parameters in this configuration. If this configuration already exists, will have no effect.
- saveConfigmonoIn:
    Saves the configuration of the inserted positions of the lenses
- loadConfigmonoIn:
    Loads the configuration of the inserted positions of the lenses
- saveConfigtest1:
    Saves the configuration of the inserted positions of the lenses
- loadConfigtest1:
    Loads the configuration of the inserted positions of the lenses
- saveConfiglens1_10:
    Saves the configuration of the inserted positions of the lenses
- loadConfiglens1_10:
    Loads the configuration of the inserted positions of the lenses

Release History
1.2.3-2.10.0

Created: | 2020-11-23T17:18:18.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T16:04:07.000Z
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T14:04:45.000Z
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T12:21:31.000Z
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T15:08:12.000Z
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T13:50:06.000Z
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T10:54:51.000Z
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T20:49:17.000Z
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T09:58:18.000Z
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T14:56:11.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T11:46:49.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T11:28:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T18:01:36.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T14:52:56.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CHAM_AX

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

###### LENS10_X

###### LENS10_Y

###### LENS1_X

###### LENS1_Y

###### LENS2_X

###### LENS2_Y

###### LENS3_X

###### LENS3_Y

###### LENS4_X

###### LENS4_Y

###### LENS5_X

###### LENS5_Y

###### LENS6_X

###### LENS6_Y

###### LENS7_X

###### LENS7_Y

###### LENS8_X

###### LENS8_Y

###### LENS9_X

###### LENS9_Y

##### SWITCH

[add component documentation]

###### LENS10_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS10_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS10_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS10_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS1_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS1_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS2_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS2_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS3_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS3_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS4_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS4_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS5_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS5_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS6_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS6_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS7_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS7_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS8_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS8_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_OUT1

Instance id: | MID_XTD6_CRL/SWITCH/LENS9_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_OUT2

Instance id: | MID_XTD6_CRL/SWITCH/LENS9_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event, MID_XTD6_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### LENS10_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS10_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS10_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS10_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS1_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS1_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS2_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS2_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS3_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS3_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS4_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS4_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS5_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS5_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T1

Instance id: | MID_XTD6_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_CRL|scene, CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T2

Instance id: | MID_XTD6_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CRL2_Event
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### IMGPI

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_IMGPI/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon206
Alias: | sa2-xtd1-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | MID_XTD6_IMPGI, MID_XTD6_IMGPI_Spot_Size, MID_XTD6_IMGPI_AVG_simple, MID_XTD6_IMGPI_AVG, MID_XTD6_IMGPI_MAIN_New
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_IMGPI/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-xtd1-sys-con-1
Class documentation:
| LimaBaslerCamera
Alias: | sa2-xtd1-sys-con-1
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | MID_XTD6_IMGPI, MID_XTD6_IMGPI_MAIN, SA2_MAIN, MID_XTD6_IMGPI_SETUP, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI/MDL/FEEDBACK|scene, SA2_MAIN, SA2_MAIN, MID_XTD6_IMGPI/CAM/BEAMVIEW, MID_XTD6_IMGPI_MAIN, MID_XTD6_IMGPI, MID_XTD6_IMGPI_SETUP, MID_XTD6_IMGPI_Spot_Size, MID_XTD6_IMGPI_AVG_simple, MID_XTD6_IMGPI_AVG, MID_XTD6_IMGPI_MAIN_New, MID_XTD6_IMGPI/CAM/BEAMVIEW, testimg, SA2_MAIN_BKR-wallpaper, MID_XTD6_Imagers, MID_XTD6_IMGPI_JITTER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | MID_XTD6_IMGPI/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | MID_XTD6_IMGPI, MID_XTD6_IMGPI_SETUP, MID_XTD6_IMGPI, MID_XTD6_IMGPI_SETUP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | MID_XTD6_IMGPI/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | MID_XTD6_IMGPI, MID_XTD6_IMGPI_MAIN, MID_XTD6_IMGPI_SETUP, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI_MAIN, MID_XTD6_IMGPI, MID_XTD6_IMGPI_SETUP, MID_XTD6_IMGPI_AVG_simple, MID_XTD6_IMGPI_MAIN_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### FEEDBACK

###### SCREEN_POSITION

Instance id: | MID_XTD6_IMGPI/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | MID_XTD6_IMGPI/MDL/SCREEN_POSITION|scene, MID_XTD6_IMGPI_MAIN, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI_MAIN0, MID_XTD6_IMGPI_MAIN, MID_XTD6_IMGPI/MDL/SCREEN_POSITION|scene, MID_XTD6_IMGPI_AVG_simple, MID_XTD6_IMGPI_MAIN_New, MID_XTD6_IMGPI/MDL/SCREEN_POSITION|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveYAG1:
    Moves the motor to the position marked with this label
- moveYAG2:
    Moves the motor to the position marked with this label
- movediamond_B:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_IMGPI/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon206
Class documentation:
| ImageProcessor
Alias: | sa2-xtd1-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | MID_XTD6_MONO/MDL/KARABACON|MainControl, MID_XTD6_IMGPI_fitted_size, Beam_POSITION, MID_XTD6_IMGPI_Spot_Size, MID_XTD6_IMGPI_AVG, MID_XTD6_IMGPI_MAIN_New
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SPROC

[add component documentation]

###### BEAMVIEW

Simple Image Processor

The `SimpleImageProcessor` device is documented in simpleimageprocessor:simple-image-processor-user

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | MID_XTD6_IMGPI/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_IMGPI, SA2_MAIN_copy
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | MID_XTD6_IMGPI/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MONO

[add component documentation]

##### ACTRL

[add component documentation]

###### HT1_I_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT1_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT1_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT2_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT2_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control, PT2_PID_FEEDBACK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT3_I_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_PROG

Instance id: | MID_XTD6_MONO/ACTRL/HT3_V_PROG
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | MID_XTD6_MONO/ACTRL/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### HT1_I_MON

Instance id: | MID_XTD6_MONO/ASENS/HT1_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_V_MON

Instance id: | MID_XTD6_MONO/ASENS/HT1_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_I_MON

Instance id: | MID_XTD6_MONO/ASENS/HT2_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_V_MON

Instance id: | MID_XTD6_MONO/ASENS/HT2_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_I_MON

Instance id: | MID_XTD6_MONO/ASENS/HT3_I_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_V_MON

Instance id: | MID_XTD6_MONO/ASENS/HT3_V_MON
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_FPITCH

Instance id: | MID_XTD6_MONO/ASENS/TOP_XTAL_FPITCH
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene, MID_XTD6_MONO/ASENS/TOP_XTAL_FPITCH|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_MONO/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### ROLLVIEW

Instance id: | MID_XTD6_MONO/AVG/ROLLVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### SIDEVIEW

Instance id: | MID_XTD6_MONO/AVG/SIDEVIEW
Class id: | ImageAverager
Host: | exflcon178
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_MONO/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-8
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | MID_XTD6_MONO/CAM/BEAMVIEW|scene, MID_XTD6_MONO/CAM/BEAMVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### ROLLVIEW

Instance id: | MID_XTD6_MONO/CAM/ROLLVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-8
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | MID_XTD6_MONO/CAM/ROLLVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### SIDEVIEW

Instance id: | MID_XTD6_MONO/CAM/SIDEVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-8
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | MID_XTD6_MONO/CAM/SIDEVIEW|scene, MID_XTD6_MONO/CAM/BEAMVIEW|scene0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM

Instance id: | MID_XTD6_MONO/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYO

Instance id: | MID_XTD6_MONO/DCTRL/CRYO
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID-MONO-TEMP, MID_XTD6_MONO_Temperature_Control, MID-MONO-TEMP, MID-MONO-TEMP, VS21050_VS21060_OLD, MID-MONO-TEMP, VS21050_VS21060_OLD, MID_XTD6_MONO/Temperatures, VS21050_VS21060, VS21050_VS21060, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP_OLD, VS21050_VS21060, VS21050_VS21060_OLD, VS21050_VS21060, MID-MONO-TEMP, VS21050_VS21060
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_ENABLE

Instance id: | MID_XTD6_MONO/DCTRL/HT1_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT1_REM_SEL

Instance id: | MID_XTD6_MONO/DCTRL/HT1_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_ENABLE

Instance id: | MID_XTD6_MONO/DCTRL/HT2_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_REM_SEL

Instance id: | MID_XTD6_MONO/DCTRL/HT2_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_ENABLE

Instance id: | MID_XTD6_MONO/DCTRL/HT3_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_Temperature_Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_REM_SEL

Instance id: | MID_XTD6_MONO/DCTRL/HT3_REM_SEL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED

###### TOP_XTAL_ROLL_LIDLE

Instance id: | MID_XTD6_MONO/DCTRL/TOP_XTAL_ROLL_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_ON

Instance id: | MID_XTD6_MONO/DCTRL/TOP_XTAL_ROLL_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LIDLE

Instance id: | MID_XTD6_MONO/DCTRL/TOP_XTAL_RPITCH_LIDLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_ON

Instance id: | MID_XTD6_MONO/DCTRL/TOP_XTAL_RPITCH_ON
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### ACCM_PITCH

###### TOP_XTAL_ROLL

Instance id: | MID_XTD6_MONO/MOTOR/TOP_XTAL_ROLL
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO/MOTOR/TOP_XTAL_ROLL|motorScene, MID_XTD6_MONO_main_scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH

Instance id: | MID_XTD6_MONO/MOTOR/TOP_XTAL_RPITCH
Class id: | BeckhoffMC2Base
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_MONO_main_scene, MID_XTD6_MONO/MOTOR/TOP_XTAL_RPITCH|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Home motor axis. This will move the motor! Make sure it is not obstructed in its movement!
- on:
    Turn the motor on. This enables movement!
- off:
    Turn the motor off. No movement is possible until it is switched on again!
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated target position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    Reset motor (axis) after an error occured!
- specificError:
    ASpecificError
- moveRelative:
    Perform a relative movement, incrementing the current position by an offset!
- move:
    Perform an absolute movement to a new target position.
- stop:
    Stop the current movement! Afterwards, the axis should be reset!
- moveConstantVelocity:
    Enable movements at a constant velocity.
- moveModulo:
    Enable modulo movements.
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- activeController:
    Select the Active Controller.
- activeControllerPLC:
    Select the Active Controller using the activeController property. This property is automatically filled and sent to the PLC

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TX

###### TY

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_XTD6_MONO/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### ROLLVIEW

Instance id: | MID_XTD6_MONO/PROC/ROLLVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### SIDEVIEW

Instance id: | MID_XTD6_MONO/PROC/SIDEVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### HT1_IS_LOC

Instance id: | MID_XTD6_MONO/SWITCH/HT1_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT2_IS_LOC

Instance id: | MID_XTD6_MONO/SWITCH/HT2_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HT3_IS_LOC

Instance id: | MID_XTD6_MONO/SWITCH/HT3_IS_LOC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_LFAULT

Instance id: | MID_XTD6_MONO/SWITCH/TOP_XTAL_ROLL_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_ROLL_TEMP

Instance id: | MID_XTD6_MONO/SWITCH/TOP_XTAL_ROLL_TEMP
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_LFAULT

Instance id: | MID_XTD6_MONO/SWITCH/TOP_XTAL_RPITCH_LFAULT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### TOP_XTAL_RPITCH_TEMP

Instance id: | MID_XTD6_MONO/SWITCH/TOP_XTAL_RPITCH_TEMP
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### PT1

Instance id: | MID_XTD6_MONO/TSENS/PT1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID-MONO-TEMP, MID_XTD6_MONO_Temperature_Control, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID_XTD6_MONO/Temperatures, MID-MONO-TEMP, MID_MONO_TEMP_OLD, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP_OLD, MID-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT2

Instance id: | MID_XTD6_MONO/TSENS/PT2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID-MONO-TEMP, MID_XTD6_MONO_Temperature_Control, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID_XTD6_MONO/Temperatures, MID-MONO-TEMP, MID_MONO_TEMP_OLD, PT2_PID_FEEDBACK, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP_OLD, MID-MONO-TEMP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PT3

Instance id: | MID_XTD6_MONO/TSENS/PT3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID-MONO-TEMP, MID_XTD6_MONO_Temperature_Control, MID-MONO-TEMP, MID-MONO-TEMP, VS21050_VS21060_OLD, MID-MONO-TEMP, VS21050_VS21060_OLD, MID_XTD6_MONO/Temperatures, VS21050_VS21060, VS21050_VS21060, MID-MONO-TEMP, MID_MONO_TEMP_OLD, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP, MID-MONO-TEMP_OLD, VS21050_VS21060, VS21050_VS21060_OLD, VS21050_VS21060, MID-MONO-TEMP, VS21050_VS21060
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | MID_XTD6_MONO/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### MDL

[add component documentation]

###### FPITCH_PROXY

###### KARABACON

Instance id: | MID_XTD6_MONO/MDL/KARABACON
Class id: | Karabacon
Host: | sa2-br-sys-con-1
Class documentation:
| Karabacon
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Karabacon
Last modified: | 2021-10-04T15:54:23.336+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mamchykd, Hauf, Fabbri
Latest tag: | 2.4.6-2.11.1
Deployment tag: | 2.4.6-2.11.1
Scenes: | MID_XTD6_MONO/MDL/KARABACON|plot, MID_XTD6_MONO/MDL/KARABACON|scene, MID_XTD6_MONO/MDL/KARABACON|MainControl, MID_XTD6_MONO/MDL/KARABACON|Plot
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- use_daq:
    If the scantool should be used without XFEL DAQ, set tofalse. Can only be set before instantiation.
- daqControllerId:
    The deviceId to the daq controller device.
- isConfigured:
    Boolean indicator if the scantool has been configured.
- actualConfiguration:
    String representation of the actual configuration applied for the scan
- activeSources:
    Alias representation of configured data sources
- activeMotors:
    Alias representation of configured motors
- activeTriggers:
    Alias representation of configured triggers
- dataEnv:
    Data Sources
- pipelineWait:
    Set this value to define the pipeline wait time for the data sources to wait for a new value
- pauseEachStep:
    Set to pause on arriving at each motor position
- reset:
    This value is used to reset the plotting
- stream:
    Internal value to signalize streaming while scanning
- isMoving:
    This boolean indicates if the karabacon is in moving state. Required for folding daq data.
- isAcquiring:
    This boolean indicates if the karabacon is acquiringdata. Required for folding daq data.
- acquisitionTime:
    The trigger sources will acquire each step for this period of time. In step scan operation, the Karabacon will wait each step to acquire for this period if configureTriggers is set to True. In continous mode, this value is used to calculate the velocity.
- configureTriggers:
    Set this value to True and the triggers will configure the acquisition time for each step
- configureVelocity:
    Set this value to True to control motor velocity during continuous motion scans. The speed will be calculated from ‘acquisitionTime’.
- availableScenes:
    Provides a scene for the Karabacon. This can be eithera control or plot related scene.
- availableMacros:
    Provides scan macros from the scan device
- output:
    Output Channel for the scan data
- configure:
    Configure the scan environment
- start:
    Start scan with previous applied configuration
- stop:
    Call this slot to stop running scan
- abort:
    Call this slot to stop everything
- pause:
    Call this slot to pause or resume running scan

Release History
2.4.6-2.11.1

Created: | 2021-08-25T16:30:39.000+02:00
Author: | Dennis Goeries
Notes: |

2.4.5-2.11.1

Created: | 2021-07-15T18:00:16.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update

2.4.4-2.11.1

Created: | 2021-07-01T20:52:35.000+02:00
Author: | Steffen Hauf
Notes: | Add MC2 subclasses

2.4.3-2.11.1

Created: | 2021-06-29T00:23:24.000+02:00
Author: | mamchykd
Notes: | Transform functions for motor aNscans, dNscans, mesh and dmesh

2.4.2-2.11.1

Created: | 2021-06-08T17:52:45.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: simulatedTrigger tag updated

2.4.1-2.11.1

Created: | 2021-06-03T08:23:54.000+02:00
Author: | mamchykd
Notes: | Macro async

2.4.0-2.10.0

Created: | 2021-03-22T13:02:09.000+01:00
Author: | Wajid Ehsan
Notes: | Fixed Data source from the output channel value issue

2.3.9-2.10.0

Created: | 2021-02-23T10:06:06.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: Integrate automated alignment extension

2.3.8-2.10.0

Created: | 2021-01-27T19:43:42.000+01:00
Author: | Wajid Ehsan
Notes: | Include JJAttenuator device into scan tool

2.3.7-2.10.0

Created: | 2021-01-13T16:04:37.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.6-2.10.0

Created: | 2020-11-24T22:22:30.000+01:00
Author: | Wajid Ehsan
Notes: | update dependency file

2.3.5-2.10.0

Created: | 2020-11-23T13:18:15.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.5-2.9.1

Created: | 2020-10-16T13:50:26.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Update for new Beckhoff state diagram Installation: No changes. Devices: No change in devices. Schema: No change in schema.

2.3.4-2.9.1

Created: | 2020-09-28T12:18:29.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Smaller fixes for misbehaving triggers, versioning, etc. Installation: No changes to dependencies, no special dependencies Devices: No change in devices. Schema: No change in schema.

2.3.3-2.9.0

Created: | 2020-06-04T17:04:30.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.2-2.8.0

Created: | 2020-05-14T13:24:49.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.8.0

Created: | 2020-04-17T14:19:55.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.7.2

Created: | 2020-03-03T13:10:32.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.8.0

Created: | 2020-03-03T13:00:40.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.6.2-2.6.0

Created: | 2020-02-28T12:16:12.000+01:00
Author: | Wajid Ehsan
Notes: | add Johann Spectrometer class

#### PBLM

[add component documentation]

##### AVG

[add component documentation]

###### L

Instance id: | MID_XTD6_PBLM/AVG/L
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | MID_Overview_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### R

Instance id: | MID_XTD6_PBLM/AVG/R
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | MID_Overview_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### L

Instance id: | MID_XTD6_PBLM/CAM/L
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | MID_Overview, CAM_LEFT, MID_XTD6_PBLM/CAM/L, MID_Overview_AVG, MID_Overview_new
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### R

Instance id: | MID_XTD6_PBLM/CAM/R
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | CAM_RIGHT, MID_Overview, MID_Overview_AVG, MID_Overview_new, MID_XTD6_PBLM/CAM/R
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER_LEFT

Instance id: | MID_XTD6_PBLM/DCTRL/CAM_POWER_LEFT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_Overview, CAM_LEFT, MID_Overview_AVG, MID_Overview_new
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_POWER_RIGHT

Instance id: | MID_XTD6_PBLM/DCTRL/CAM_POWER_RIGHT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CAM_RIGHT, MID_Overview, MID_Overview_AVG, MID_Overview_new
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### ALARM

Instance id: | MID_XTD6_PBLM/MDL/ALARM
Class id: | GenericEstimator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

##### MOTOR

[add component documentation]

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### PROC

[add component documentation]

###### L

Instance id: | MID_XTD6_PBLM/PROC/L
Class id: | ImageProcessor
Host: | exflcon196
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM_LEFT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### COLLISION_HOR

Instance id: | MID_XTD6_PBLM/SWITCH/COLLISION_HOR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### COLLISION_VER

Instance id: | MID_XTD6_PBLM/SWITCH/COLLISION_VER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### BLADE_BOTTOM

Instance id: | MID_XTD6_PBLM/TSENS/BLADE_BOTTOM
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT

Instance id: | MID_XTD6_PBLM/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT

Instance id: | MID_XTD6_PBLM/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP

Instance id: | MID_XTD6_PBLM/TSENS/BLADE_TOP
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### L_TRIGGER

Instance id: | MID_XTD6_PBLM/TSYS/L_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### R_TRIGGER

Instance id: | MID_XTD6_PBLM/TSYS/R_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### PSLIT-1

Instance id: | MID_XTD6_PSLIT-1
Class id: | SlitSystem
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slitSystem
Last modified: | 2021-01-13T14:43:03.000+01:00
Created at: | 2016-11-16T14:10:53.000+01:00
Main authors: | Marsa, Carinan, Hickin
Latest tag: | 2.5.3-2.10.0
Deployment tag: | 2.5.3-2.10.0
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | SA2_MAIN, MID_XTD6_PSLIT-1|Control, MID_XTD6_PSLIT-1|SimpleControl, MID_XTD6_PSLIT-1/MOTOR/BLADE_LEFT|motorScene, MID_XTD6_PSLIT-1/MOTOR/BLADE_TOP|motorScene, SA2_MAIN, MID_XTD6_PSLIT-1|Control, MID_XTD6_PSLIT-1/MOTOR/BLADE_RIGHT|motorScene, MID_XTD6_PSLIT-1/MOTOR/BLADE_TOP|motorScene, MID_XTD6_PSLIT-1/MOTOR/BLADE_BOTTOM|motorScene, MID_XTD6_PSLIT-1|SimpleControl, MID_XTD6_PSLIT-1/MOTOR/BLADE_LEFT|motorScene, MID_XTD6_PSLIT-1_parameters, SA2_MAIN_BKR-wallpaper, MID_XTD6_PSLIT-1/MOTOR/BLADE_RIGHT|motorScene, MID_XTD6_PSLIT-1/MOTOR/BLADE_BOTTOM|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

##### Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- offsetLeft:
    Left offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetRight:
    Right offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetTop:
    Top offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetBot:
    Bot offset of motor, can only be set before instantiation or via the calibrate slot.
- reverseLeft:
    Reverse direction of Left motor axis in relation to X. Can only be set before instantiation.
- reverseRight:
    Reverse direction of Right motor axis in relation to X. Can only be set before instantiation.
- reverseTop:
    Reverse direction of Top motor axis in relation to Y. Can only be set before instantiation.
- reverseBottom:
    Reverse direction of Bot motor axis in relation to Y, can only be set before instantiation.
- positionIn:
    The defined in position. Save parameters by editing before instatiation.
- positionOut:
    The defined in position. Save parameters by editing before instatiation.
- motor:
    The motor InstanceId of the motors of the slit system.
- open:
    Open slit one step
- close:
    Close slit one step
- right:
    Move slit one step in +X
- left:
    Move slit one step in -X
- up:
    Move slit one step in Y
- down:
    Move slit one step in -Y
- closeX:
    Close slit one step in X
- openX:
    Open slit one step in X
- openY:
    Open slit one step in Y
- closeY:
    Close slit one step in Y
- calibrate:
    Set the motors offset once the slit device is CENTERED and CLOSED
- calibrateX:
    Set the motors offset in horizontal once the slit device is CENTERED and CLOSED
- calibrateY:
    Set the motors offset in vertical once the slit device is CENTERED and CLOSED
- availableScenes:
    Scenes from the Slit System

##### Release History

###### 2.5.3-2.10.0

Created: | 2021-01-13T14:43:36.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.2-2.10.0

Created: | 2020-12-23T16:44:35.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.1-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: | Summary: add CI

###### 2.5.0-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.4.0-2.2.4

Created: | 2018-06-07T09:11:44.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.5-2.2.1

Created: | 2018-04-27T11:11:40.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.4-2.2.1

Created: | 2018-03-22T14:15:20.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.3-2.2.1

Created: | 2018-03-15T10:55:54.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.2-2.2.1

Created: | 2018-03-06T13:08:58.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.1-2.2.1

Created: | 2018-02-19T18:21:55.000+01:00
Author: | Dennis Goeries
Notes: | Scene update

###### 2.3.0-2.2.1

Created: | 2018-02-19T13:27:25.000+01:00
Author: | Alessandro Silenzi
Notes: | Included SPB interface and default scenes

###### 2.2.0-2.2.0

Created: | 2017-12-12T17:37:51.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.1.9-2.1.16

Created: | 2017-10-23T13:42:52.000+02:00
Author: | David Hickin
Notes: |

###### 2.1.8-2.1.14

Created: | 2017-08-17T19:23:39.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.7-2.1.14

Created: | 2017-08-14T15:41:33.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.6-2.1.12

Created: | 2017-07-19T15:28:26.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.5

Created: | 2017-03-02T18:29:17.000+01:00
Author: | Dennis Goeries
Notes: | Migrated slitSystem

#### PSLIT-1

[add component documentation]

##### MOTOR

[add component documentation]

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

[add component documentation]

###### APERTURE_TA

Instance id: | MID_XTD6_PSLIT-1/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### APERTURE_TB

Instance id: | MID_XTD6_PSLIT-1/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_BOTTOM_TA

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_BOTTOM_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_BOTTOM_TB

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_BOTTOM_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_TA

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_LEFT_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_TB

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_LEFT_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_TA

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_RIGHT_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_TB

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_RIGHT_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_TA

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_TOP_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_TB

Instance id: | MID_XTD6_PSLIT-1/TSENS/BLADE_TOP_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | MID_XTD6_PSLIT-1, SA2_MAIN_copy
Scenes: | MID_XTD6_PSLIT-1|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### PSLIT-2

[add component documentation]

##### MOTOR

[add component documentation]

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### TSENS

[add component documentation]

###### APERTURE_TA

Instance id: | MID_XTD6_PSLIT-2/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### APERTURE_TB

Instance id: | MID_XTD6_PSLIT-2/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_BOTTOM_TA

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_BOTTOM_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_BOTTOM_TB

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_BOTTOM_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_TA

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_LEFT_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_TB

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_LEFT_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_TA

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_RIGHT_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_TB

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_RIGHT_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_TA

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_TOP_TA
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_TB

Instance id: | MID_XTD6_PSLIT-2/TSENS/BLADE_TOP_TB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | MID_XTD6_PSLIT-2|Control
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### PSLIT2

Instance id: | MID_XTD6_PSLIT2
Class id: | SlitSystem
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slitSystem
Last modified: | 2021-01-13T14:43:03.000+01:00
Created at: | 2016-11-16T14:10:53.000+01:00
Main authors: | Marsa, Carinan, Hickin
Latest tag: | 2.5.3-2.10.0
Deployment tag: | 2.5.3-2.10.0
Scenes: | SA2_MAIN, MID_XTD6_PSLIT-2|Control, SA2_MAIN, SA2_MAIN_BKR-wallpaper, MID_XTD6_PSLIT-2|SimpleControl
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

##### Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- offsetLeft:
    Left offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetRight:
    Right offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetTop:
    Top offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetBot:
    Bot offset of motor, can only be set before instantiation or via the calibrate slot.
- reverseLeft:
    Reverse direction of Left motor axis in relation to X. Can only be set before instantiation.
- reverseRight:
    Reverse direction of Right motor axis in relation to X. Can only be set before instantiation.
- reverseTop:
    Reverse direction of Top motor axis in relation to Y. Can only be set before instantiation.
- reverseBottom:
    Reverse direction of Bot motor axis in relation to Y, can only be set before instantiation.
- positionIn:
    The defined in position. Save parameters by editing before instatiation.
- positionOut:
    The defined in position. Save parameters by editing before instatiation.
- motor:
    The motor InstanceId of the motors of the slit system.
- open:
    Open slit one step
- close:
    Close slit one step
- right:
    Move slit one step in +X
- left:
    Move slit one step in -X
- up:
    Move slit one step in Y
- down:
    Move slit one step in -Y
- closeX:
    Close slit one step in X
- openX:
    Open slit one step in X
- openY:
    Open slit one step in Y
- closeY:
    Close slit one step in Y
- calibrate:
    Set the motors offset once the slit device is CENTERED and CLOSED
- calibrateX:
    Set the motors offset in horizontal once the slit device is CENTERED and CLOSED
- calibrateY:
    Set the motors offset in vertical once the slit device is CENTERED and CLOSED
- availableScenes:
    Scenes from the Slit System

##### Release History

###### 2.5.3-2.10.0

Created: | 2021-01-13T14:43:36.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.2-2.10.0

Created: | 2020-12-23T16:44:35.000+01:00
Author: | David Hickin
Notes: |

###### 2.5.1-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: | Summary: add CI

###### 2.5.0-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.4.0-2.2.4

Created: | 2018-06-07T09:11:44.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.5-2.2.1

Created: | 2018-04-27T11:11:40.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.3.4-2.2.1

Created: | 2018-03-22T14:15:20.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.3-2.2.1

Created: | 2018-03-15T10:55:54.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.2-2.2.1

Created: | 2018-03-06T13:08:58.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.3.1-2.2.1

Created: | 2018-02-19T18:21:55.000+01:00
Author: | Dennis Goeries
Notes: | Scene update

###### 2.3.0-2.2.1

Created: | 2018-02-19T13:27:25.000+01:00
Author: | Alessandro Silenzi
Notes: | Included SPB interface and default scenes

###### 2.2.0-2.2.0

Created: | 2017-12-12T17:37:51.000+01:00
Author: | Dennis Goeries
Notes: |

###### 2.1.9-2.1.16

Created: | 2017-10-23T13:42:52.000+02:00
Author: | David Hickin
Notes: |

###### 2.1.8-2.1.14

Created: | 2017-08-17T19:23:39.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.7-2.1.14

Created: | 2017-08-14T15:41:33.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.6-2.1.12

Created: | 2017-07-19T15:28:26.000+02:00
Author: | Dennis Goeries
Notes: |

###### 2.1.5

Created: | 2017-03-02T18:29:17.000+01:00
Author: | Dennis Goeries
Notes: | Migrated slitSystem

#### SHUT

[add component documentation]

##### DCTRL

[add component documentation]

###### ACLOSED

Instance id: | MID_XTD6_SHUT/DCTRL/ACLOSED
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | MID_XTD6_SHUT/DCTRL/AOPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### ACLOSED

Instance id: | MID_XTD6_SHUT/SWITCH/ACLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, MPS_TEST, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VS21070_V21080, VAC_TO_MPS_USER_OLD, VS21070_V21080_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | MID_XTD6_SHUT/SWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, SA2_EPS2MPS, VAC_TO_MPS_EXPERT, SA2_MAIN, MPS_TEST, VS21070_V21080, VS21070_VS21080, VS21070_VS21080, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VS21070_VS21080_MID_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VS21070_V21080, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VS21070_V21080, VS21070_VS21080_OLD, VAC_TO_MPS_USER_OLD, VS21070_V21080, VS21070_V21080_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VS21070_VS21080, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, VS21070_VS21080_MID, VS21070_VS21080_MID, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WATER

Instance id: | MID_XTD6_SHUT/SWITCH/WATER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### T1

Instance id: | MID_XTD6_SHUT/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | MID_XTD6_SHUT/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T3

Instance id: | MID_XTD6_SHUT/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T4

Instance id: | MID_XTD6_SHUT/TSENS/T4
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VSWITCH

[add component documentation]

###### AOPEN

Instance id: | MID_XTD6_SHUT/VSWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### WATCHDOG

[add component documentation]

##### MDL

[add component documentation]

###### DIAMOND_IMGPI

Instance id: | MID_XTD6_WATCHDOG/MDL/DIAMOND_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, MID_XTD6_IMGPI_MAIN, SA2_MAIN, MID_XTD6_IMGPI_MAIN0, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### YAG_IMGPI

Instance id: | MID_XTD6_WATCHDOG/MDL/YAG_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, MID_XTD6_IMGPI_MAIN, SA2_MAIN, MID_XTD6_IMGPI_MAIN0, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### BEAM_POSITION_IMGPI

Instance id: | MID_XTD6_WATCHDOG/MDL/BEAM_POSITION_IMGPI
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-06-30T17:55:32.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Hauf, Mamchykd, Haufs
Latest tag: | 1.10.6-2.11.1
Deployment tag: | 1.10.6-2.11.1
Scenes: | MID_XTD6_IMGPI_MAIN
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.6-2.11.1

Created: | 2021-06-24T12:35:44.000Z
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

###### AVG_IMGPI_1

###### AVG_IMGPI_2

###### BEAM_POSITION_IMGPI_1

Instance id: | MID_XTD6_WATCHDOG/MDL/BEAM_POSITION_IMGPI_1
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### BEAM_POSITION_IMGPI_2

Instance id: | MID_XTD6_WATCHDOG/MDL/BEAM_POSITION_IMGPI_2
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | MID_XTD6_IMGPI_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

### BR

[add component documentation]

#### SYS

[add component documentation]

##### MDL

[add component documentation]

###### KARABACON

Instance id: | MID_BR_SYS/MDL/KARABACON
Class id: | Karabacon
Host: | exflcon57n0
Class documentation:
| Karabacon
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2020-11-25T14:18:05.000+01:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Xctrl, Ehsan, Ehsanw
Latest tag: | 2.3.6-2.10.0
Deployment tag: | 2.3.6-2.10.0
Scenes: | MID_BR_SYS/MDL/KARABACON|Plot
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- 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.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: |

2.2.0-2.7.0

Created: | 2019-12-04T15:15:33.000Z
Author: | Dennis Goeries
Notes: |

1.6.1-2.6.0

Created: | 2019-10-02T16:15:26.000Z
Author: | Wajid Ehsan
Notes: | Include pplaserDelayCopy Device.

1.6.0-2.6.0

Created: | 2019-09-11T14:54:42.000Z
Author: | Dennis Goeries
Notes: |

1.5.0-2.6.0

Created: | 2019-06-04T12:03:20.000Z
Author: | Dennis Goeries
Notes: |

1.4.6-2.4.0

Created: | 2019-05-28T09:43:44.000Z
Author: | Wajid Ehsan
Notes: | Include APD class from BeamPositionMonitor Device

1.4.5-2.4.0

Created: | 2019-05-17T17:47:43.000Z
Author: | David Hickin
Notes: | Include Doocs undulator class

1.4.4-2.4.0

Created: | 2019-05-14T13:13:03.000Z
Author: | Robert Schaffer
Notes: | Added proxy processor device, for cross topic scans

1.4.3-2.4.0

Created: | 2019-05-07T12:35:12.000Z
Author: | Dennis Goeries
Notes: |

### AUXT2

[add component documentation]

#### IMGPI

[add component documentation]

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_AUXT2_IMGPI/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

### EXP

[add component documentation]

#### DES

[add component documentation]

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_EXP_DES/PROC/CAM1
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

###### CAM2

Instance id: | MID_EXP_DES/PROC/CAM2
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Scenes: | BeamPosition
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

###### CAM3

Instance id: | MID_EXP_DES/PROC/CAM3
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Scenes: | BeamPosition
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

#### SAM

[add component documentation]

##### PROC

[add component documentation]

###### CAM1

Instance id: | MID_EXP_SAM/PROC/CAM1
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

###### CAM2

Instance id: | MID_EXP_SAM/PROC/CAM2
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

###### CAM3

Instance id: | MID_EXP_SAM/PROC/CAM3
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

### TOEPS

[add component documentation]

#### PILC1

[add component documentation]

##### VSWITCH

[add component documentation]

###### EXP_BS_ABS_CLOSED

Instance id: | MID_TOEPS_PILC1/VSWITCH/EXP_BS_ABS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EXP_BS_ABS_OPEN

Instance id: | MID_TOEPS_PILC1/VSWITCH/EXP_BS_ABS_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPT_BS_ABS_CLOSED

Instance id: | MID_TOEPS_PILC1/VSWITCH/OPT_BS_ABS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPT_BS_ABS_OPEN

Instance id: | MID_TOEPS_PILC1/VSWITCH/OPT_BS_ABS_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

### OPT

[add component documentation]

#### MONO

[add component documentation]

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | MID_OPT_MONO/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

###### SIDEVIEW

Instance id: | MID_OPT_MONO/PROC/SIDEVIEW
Class id: | ImageProcessor
Host: | sa2-br-sys-con-8
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/karaboDevices/imageProcessor
Last modified: | 2021-09-15T17:52:29.436+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.28.0alpha-2.11.4
Deployment tag: | 1.28.0alpha-2.11.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.28.0alpha-2.11.4

Created: | 2021-09-15T17:52:18.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Add crosshair and marker capabilities (alpha tag).

1.27.5-2.11.1

Created: | 2021-08-03T17:11:31.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use image averaging from imageProcessing package.

1.27.4-2.10.0

Created: | 2020-11-23T12:51:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T14:29:13.000+02:00
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T14:08:55.000+02:00
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T13:53:30.000+02:00
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T11:23:50.000+01:00
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T16:58:22.000+01:00
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T14:13:22.000+01:00
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T09:12:39.000+02:00
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T17:59:16.000+02:00
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T17:06:43.000+02:00
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T14:46:06.000+02:00
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T16:57:59.000+02:00
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T09:31:19.000+02:00
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T16:19:56.000+02:00
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T10:20:28.000+02:00
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T13:41:45.000+02:00
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T16:59:33.000+02:00
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T14:34:21.000+02:00
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

## SA2

[add component documentation]

### BR

[add component documentation]

#### SYS

[add component documentation]

##### MDL

[add component documentation]

###### TRIGGER

Instance id: | SA2_BR_SYS/MDL/TRIGGER
Class id: | SimulatedTrigger
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/simulatedTrigger
Last modified: | 2021-05-25T11:57:57.000+02:00
Created at: | 2017-11-09T17:34:21.000+01:00
Main authors: | Danilevski, Xctrl, Degon
Latest tag: | 1.1.1-2.10.4
Deployment tag: | 1.1.1-2.10.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- interfaces:
    Describes the interfaces for this device
- acquisitionTime:
    The triggers stays this long in ACQUIRING state

Release History
1.1.1-2.10.4

Created: | 2021-05-25T12:07:21.000+02:00
Author: | Gero Flucke
Notes: |

1.1.0-2.10.0

Created: | 2020-11-19T15:36:43.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.3.0

Created: | 2018-11-21T18:01:59.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.2

Created: | 2018-03-02T15:17:19.000+01:00
Author: | Dennis Goeries
Notes: |

###### DAQCTRL_2

Instance id: | SA2_BR_SYS/MDL/DAQCTRL_2
Class id: | DaqController
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/daqController
Last modified: | 2021-07-15T17:12:00.000+02:00
Created at: | 2019-03-11T15:44:30.000+01:00
Main authors: | Mamchykd, Parenti, Haufs
Latest tag: | 1.4.6-2.11.1
Deployment tag: | 1.4.6-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- autoFill:
    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.
- dataAggregators:
    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.6-2.11.1

Created: | 2021-07-15T17:35:57.000+02:00
Author: | mamchykd
Notes: | Tag from master, contains the fixes related to DaqGlobaState for the Agipd and the Scantool.

1.4.5-2.11.1

Created: | 2021-07-14T20:38:33.000+02:00
Author: | mamchykd
Notes: | A tag from branch, tested with Agipd Dark Proc on Jul 13 2021. To be tested with the Scantools.

1.4.4-2.10.0-hotfix@SPB

Created: | 2021-02-24T17:55:09.000+01:00
Author: | Gabriele Giovanetti
Notes: | For use with JungfrauDarkChar device

1.4.4-2.10.0

Created: | 2020-11-24T22:11:03.000+01:00
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T10:53:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T14:48:22.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T13:27:28.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T16:30:28.000+02:00
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T12:43:24.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T11:20:59.000+02:00
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T13:03:14.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T12:52:23.000+01:00
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T13:19:01.000+02:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T17:29:20.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T11:22:23.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T18:38:41.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T17:45:23.000+02:00
Author: | Dennis Goeries
Notes: |

###### KARABACON

Instance id: | SA2_BR_SYS/MDL/KARABACON
Class id: | Karabacon
Host: | sa2-br-sys-con-1
Class documentation:
| Karabacon
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Karabacon
Last modified: | 2021-10-04T15:54:23.336+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mamchykd, Hauf, Fabbri
Latest tag: | 2.4.6-2.11.1
Deployment tag: | 2.4.6-2.11.1
Scenes: | SA2_BR_SYS/MDL/KARABACON|MainControl, SA2_BR_SYS/MDL/KARABACON|Plot, SA2_BR_SYS/MDL/KARABACON|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- use_daq:
    If the scantool should be used without XFEL DAQ, set tofalse. Can only be set before instantiation.
- daqControllerId:
    The deviceId to the daq controller device.
- isConfigured:
    Boolean indicator if the scantool has been configured.
- actualConfiguration:
    String representation of the actual configuration applied for the scan
- activeSources:
    Alias representation of configured data sources
- activeMotors:
    Alias representation of configured motors
- activeTriggers:
    Alias representation of configured triggers
- dataEnv:
    Data Sources
- pipelineWait:
    Set this value to define the pipeline wait time for the data sources to wait for a new value
- pauseEachStep:
    Set to pause on arriving at each motor position
- reset:
    This value is used to reset the plotting
- stream:
    Internal value to signalize streaming while scanning
- isMoving:
    This boolean indicates if the karabacon is in moving state. Required for folding daq data.
- isAcquiring:
    This boolean indicates if the karabacon is acquiringdata. Required for folding daq data.
- acquisitionTime:
    The trigger sources will acquire each step for this period of time. In step scan operation, the Karabacon will wait each step to acquire for this period if configureTriggers is set to True. In continous mode, this value is used to calculate the velocity.
- configureTriggers:
    Set this value to True and the triggers will configure the acquisition time for each step
- configureVelocity:
    Set this value to True to control motor velocity during continuous motion scans. The speed will be calculated from ‘acquisitionTime’.
- availableScenes:
    Provides a scene for the Karabacon. This can be eithera control or plot related scene.
- availableMacros:
    Provides scan macros from the scan device
- output:
    Output Channel for the scan data
- configure:
    Configure the scan environment
- start:
    Start scan with previous applied configuration
- stop:
    Call this slot to stop running scan
- abort:
    Call this slot to stop everything
- pause:
    Call this slot to pause or resume running scan

Release History
2.4.6-2.11.1

Created: | 2021-08-25T16:30:39.000+02:00
Author: | Dennis Goeries
Notes: |

2.4.5-2.11.1

Created: | 2021-07-15T18:00:16.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update

2.4.4-2.11.1

Created: | 2021-07-01T20:52:35.000+02:00
Author: | Steffen Hauf
Notes: | Add MC2 subclasses

2.4.3-2.11.1

Created: | 2021-06-29T00:23:24.000+02:00
Author: | mamchykd
Notes: | Transform functions for motor aNscans, dNscans, mesh and dmesh

2.4.2-2.11.1

Created: | 2021-06-08T17:52:45.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: simulatedTrigger tag updated

2.4.1-2.11.1

Created: | 2021-06-03T08:23:54.000+02:00
Author: | mamchykd
Notes: | Macro async

2.4.0-2.10.0

Created: | 2021-03-22T13:02:09.000+01:00
Author: | Wajid Ehsan
Notes: | Fixed Data source from the output channel value issue

2.3.9-2.10.0

Created: | 2021-02-23T10:06:06.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: Integrate automated alignment extension

2.3.8-2.10.0

Created: | 2021-01-27T19:43:42.000+01:00
Author: | Wajid Ehsan
Notes: | Include JJAttenuator device into scan tool

2.3.7-2.10.0

Created: | 2021-01-13T16:04:37.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.6-2.10.0

Created: | 2020-11-24T22:22:30.000+01:00
Author: | Wajid Ehsan
Notes: | update dependency file

2.3.5-2.10.0

Created: | 2020-11-23T13:18:15.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.5-2.9.1

Created: | 2020-10-16T13:50:26.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Update for new Beckhoff state diagram Installation: No changes. Devices: No change in devices. Schema: No change in schema.

2.3.4-2.9.1

Created: | 2020-09-28T12:18:29.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Smaller fixes for misbehaving triggers, versioning, etc. Installation: No changes to dependencies, no special dependencies Devices: No change in devices. Schema: No change in schema.

2.3.3-2.9.0

Created: | 2020-06-04T17:04:30.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.2-2.8.0

Created: | 2020-05-14T13:24:49.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.8.0

Created: | 2020-04-17T14:19:55.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.7.2

Created: | 2020-03-03T13:10:32.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.8.0

Created: | 2020-03-03T13:00:40.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.6.2-2.6.0

Created: | 2020-02-28T12:16:12.000+01:00
Author: | Wajid Ehsan
Notes: | add Johann Spectrometer class

###### MID_REPEATER

Instance id: | SA2_BR_SYS/MDL/MID_REPEATER
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### EPS_POWER_LIMIT

##### PLC

[add component documentation]

###### EPS

Instance id: | SA2_BR_SYS/PLC/EPS
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EPS_PLCMON

Instance id: | SA2_BR_SYS/PLC/EPS_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HED

Instance id: | SA2_BR_SYS/PLC/HED
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### HED_PLCMON

Instance id: | SA2_BR_SYS/PLC/HED_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MASTER

Instance id: | SA2_BR_SYS/PLC/MASTER
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MASTER_PLCMON

Instance id: | SA2_BR_SYS/PLC/MASTER_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MID

Instance id: | SA2_BR_SYS/PLC/MID
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview, MID_XTD6_PSLIT-1_parameters, MID_XTD6_PSLIT-2_parameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MID_PLCMON

Instance id: | SA2_BR_SYS/PLC/MID_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview, MID_XTD6_PSLIT-1_parameters, MID_XTD6_PSLIT-2_parameters
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MOV1

Instance id: | SA2_BR_SYS/PLC/MOV1
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MOV1_PLCMON

Instance id: | SA2_BR_SYS/PLC/MOV1_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MOV2

Instance id: | SA2_BR_SYS/PLC/MOV2
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MOV2_PLCMON

Instance id: | SA2_BR_SYS/PLC/MOV2_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VAC

Instance id: | SA2_BR_SYS/PLC/VAC
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-1
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VAC_PLCMON

Instance id: | SA2_BR_SYS/PLC/VAC_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XGM

Instance id: | SA2_BR_SYS/PLC/XGM
Class id: | BeckhoffCom
Host: | sa2-br-sys-con-2
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- reset:
    Resets the Karabo device in case of an error
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- interlockReadOnly:
    Will set this property on device instantiation. See device schema for description.
- disableEpsilonFeedback:
    Will set this property on device instantiation. See device schema for description.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- busyQueueThreshold:
    Request queue lengths towards the PLC at which a busy queue is reported. Set to 0 to not check if busy.
- requestQueueSize:
    Size of the queue buffering requests to the PLC. Shows the maximum value in the last second.
- propertyNoiseLimit:
    Each Beckhoff Device will receive at most propertyNoiseLimit updates per TCP message. 0 means no limit.
- noisyUpdates:
    Number of times any property was overwritten since hitting the propertyNoiseLimit limit.
- noisyProperties:
    Comma separated properties read from PLC with their numbers that an update was overwritten since hitting the ‘propertyNoiseLimit’ limit
- messagesMerged:
    Number of times the information from a TCP message was merged.
- tasksPending:
    Number of pending tasks in the internal queue.
- waitOnInstantiation:
    Instantiate the Beckhoff device one after another, waiting for any instantiation to be completed before proceeding to the next. To be used for PLCs with unusually large number of devices.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XGM_PLCMON

Instance id: | SA2_BR_SYS/PLC/XGM_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TrainId_overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### UTC

[add component documentation]

##### MDL

[add component documentation]

###### BUNCHPATTERN_DECODER

Instance id: | SA2_BR_UTC/MDL/BUNCHPATTERN_DECODER
Class id: | PulsePatternDecoder
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/pulsePatternDecoder
Last modified: | 2021-09-10T16:40:35.942+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Haufs, Mercadier, Ehsan
Latest tag: | 2.0.5-2.11.0
Deployment tag: | 2.0.5-2.11.0
Installed tag: | 2.0.5-2.11.0
Scenes: | BunchPatternServerS2, test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Pulse Pattern Decoder Documentation

The `Pulse Pattern Decoder` device is documented in pulsepatterndecoder:pulsepatterndecoder

Pulse Pattern Decoder Troubleshooting

To troubleshooting documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- input:
    Process the data received from the input channel.

Release History
2.0.5-2.11.0

Created: | 2021-07-23T15:24:27.000+02:00
Author: | Alessandro Silenzi
Notes: | no change in schema

2.0.4-2.10.4

Created: | 2021-05-17T19:36:32.000+02:00
Author: | Alessandro Silenzi
Notes: | Added Laser decoding to the PulsePatternDecoder

2.0.3-2.10.0

Created: | 2020-11-24T13:00:46.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.0.2-2.9.6-log-timestamps

Created: | 2020-09-24T14:48:03.000+02:00
Author: | Gabriele Giovanetti
Notes: |

2.0.2-2.9.6

Created: | 2020-09-16T15:50:05.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: prevent unwanted task in karabo 2.9 note: can be used also with other karabo versions

2.0.1-2.9.6

Created: | 2020-09-11T14:56:10.000+02:00
Author: | Gabriele Giovanetti
Notes: | Prevent timestamp jumping backwards

2.0.0-2.9.4-hotfix@SPB

Created: | 2020-09-11T14:11:25.000+02:00
Author: | Gabriele Giovanetti
Notes: | Temporary hotfix: bunchpattern table timestamp propagation leads to wrong data in DAQ

2.0.0-2.9.4

Created: | 2020-08-17T14:53:49.000+02:00
Author: | Steffen Hauf
Notes: | Read the patternTable via an input channel

1.5.0-2.7.0-hotfix

Created: | 2020-07-23T18:04:33.000+02:00
Author: | degon
Notes: | hotfix: fire start slot twice for digitizer

1.5.0-2.7.0

Created: | 2020-03-03T12:36:56.000+01:00
Author: | Wajid Ehsan
Notes: | Integration of new device class which facilitates the integration of Bunch pattern integration into Digitizer

1.4.1-2.6.1

Created: | 2019-11-12T14:57:06.000+01:00
Author: | Denys Mamchyk
Notes: | minor fix for updating the status on error

1.4.0-2.6.1

Created: | 2019-10-04T14:14:33.000+00:00
Author: | Valerii Bondar
Notes: | “Proper” deployment tag from ‘master’ branch. Includes OperationChangeNotifier with no prints.

1.4.0-2.6.1-test

Created: | 2019-10-02T18:48:32.000+02:00
Author: | Valerii Bondar
Notes: | Left by Valerii in his rush to the airport, but we need it now. Print statement must be removed

1.3.2-2.5.0-Notifier

Created: | 2019-09-23T13:53:03.000+02:00
Author: | Valerii Bondar
Notes: | This tag is only for tests of OperationChangeNotifier prototype in MID topic. For production deployment use ‘proper’ tag recommended. This tag should be installed only afterwards (with install_device_active.yml) and decommissioned after tests.

1.3.2-2.5.0

Created: | 2019-08-07T17:00:04.000+02:00
Author: | Denys Mamchyk
Notes: | update for rawDelay calculation

1.3.1-2.5.0

Created: | 2019-08-02T17:21:20.000+02:00
Author: | Wajid Ehsan
Notes: | Set pulse Delay

1.3.0-2.5.0

Created: | 2019-07-30T13:43:21.000+02:00
Author: | Cammille Carinan
Notes: | Integration of bunch pattern setting into fastadc device.

1.2.0-2.3.0

Created: | 2019-03-13T19:08:04.000+01:00
Author: | Alessandro Silenzi
Notes: | Using the euxfel_bunch_pattern package

1.1.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | added MainDump node

1.0.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | Main dump is included in the decoding

##### TSYS

[add component documentation]

###### TIMESERVER

Instance id: | SA2_BR_UTC/TSYS/TIMESERVER
Class id: | TimeServer
Host: | sa2-xtd1-sys-utc-r21
Class documentation:
| TimeServer
Alias: | sa2-xtd1-sys-utc-r21-mch , sa2-xtd1-sys-utc-r21
Git repo: | https://git.xfel.eu/karaboDevices/timeServer
Last modified: | 2021-09-14T08:39:06.351+02:00
Created at: | 2016-12-02T14:04:29.000+01:00
Main authors: | Hauf, Haufs, Fabbri
Latest tag: | 2.8.1-2.11.1
Deployment tag: | 2.8.1-2.11.1
Installed tag: | 2.8.0-2.10.0
Projects: | SA2_TIMERSERVER, SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (2.8.0-2.10.0) does not match tags mentioned in the deployment ([‘2.8.1-2.11.1’])!

Time Server Documentation

The `Time Server` device is documented in timeServer:timeServer

Time Server Troubleshooting

To troubleshooting documentation

TrainId Workflow and Entities

To Train Id workflow documentation

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- reset:
    Resets the device in case of an error
- id:
    Most recently published actual trigger ID
- periodActual:
    Most recently published actual period of the ID value increment
- idDiff:
    Difference of ID and its previously published value divided by tick factor
- source:
    Select source of trigger ID as an URI (‘local://internal’, ‘local://x2timer’, or ‘tcp://host:port’)
- devfile:
    Local device file to be used if “local://x2timer” was selected
- periodSet:
    Setpoint for the period of the ID value increment (used only for internally generated ID)
- minPeriod:
    Minimum period value to emit a signal.
- maxPeriod:
    Maximum period value to emit a signal.
- badTrainIdsCounter:
    Counter for non increasing trainId events. Maxes out at 100
- badPeriodsCounter:
    Number of times in a tick factor where the period has been set to 0
- badPeriods:
    Last periods out of bounds
- readBunchPatternTable:
    This flag enables the reading of bunch pattern table. To get the full bunch pattern tables with every train use the ‘Full Bunch Pattern Table Updates’ flag.
- bunchPatternTable:
    Is only output if both the ‘readBunchPatternTable’ and ‘fullBunchPatternUpdates’ flags are set.
- fullBunchPatternUpdates:
    If set to true the full bunch pattern table will be updated for each train and logged.
- outputBunchPattern:
    Output channel to which bunch pattern updates are sent. Bunch patterns are only output if the ‘readBunchPatternTable’ is set.

Release History
2.8.1-2.11.1

Created: | 2021-02-10T16:51:00.000+01:00
Author: | Gabriele Giovanetti
Notes: | ‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created: | 2021-02-05T11:41:17.000+01:00
Author: | Gero Flucke
Notes: | Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

Created: | 2020-11-24T08:08:35.000+01:00
Author: | Steffen Hauf
Notes: |

2.7.5-2.9.1

Created: | 2020-09-21T14:07:33.000+02:00
Author: | Alessandro Silenzi
Notes: | Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created: | 2020-08-17T11:38:17.000+02:00
Author: | Riccardo Fabbri
Notes: | PatternTable array moved into data node of output channel for DAQ compatibility.

2.7.3-2.9.1

Created: | 2020-07-22T16:18:32.000+02:00
Author: | Riccardo Fabbri
Notes: | Added slot for toggling data processing.

2.7.2-2.9.1

Created: | 2020-07-08T22:40:51.000+02:00
Author: | Riccardo Fabbri
Notes: | PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created: | 2020-06-26T19:26:19.000+02:00
Author: | Riccardo Fabbri
Notes: | Derive from BunchPattern digest a class with the metrics for PPL bits.

2.7.0-2.9.0

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: |

2.7.0-2.9

Created: | 2020-05-27T15:47:21.000+02:00
Author: | Steffen Hauf
Notes: | Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created: | 2020-02-12T15:34:09.000+01:00
Author: | Gero Flucke
Notes: | Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created: | 2019-05-07T16:35:38.000+02:00
Author: | Alessandro Silenzi
Notes: | Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created: | 2019-01-23T10:01:43.000+01:00
Author: | Alessandro Silenzi
Notes: | FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created: | 2018-12-10T14:26:22.000+01:00
Author: | Alessandro Silenzi
Notes: | added DAQ Policy

2.5.0-2.2.6

Created: | 2018-11-29T16:54:33.000+01:00
Author: | Alessandro Silenzi
Notes: | Added read Bunch Pattern table feature

2.4.0-2.1.15

Created: | 2018-02-27T11:18:55.000+01:00
Author: | Gero Flucke
Notes: | Publish signalled trainIds to data logger

2.3.2-2.1.15

Created: | 2017-09-14T15:41:19.000+02:00
Author: | Sergey Esenov
Notes: | Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created: | 2017-08-25T10:54:38.000+02:00
Author: | Sergey Esenov
Notes: | Use timing from timing board with the following priority: ‘master’, ‘global’ or ‘board’ to avoid zero values.

2.3.0-2.1.15

Created: | 2017-08-20T14:55:53.000+02:00
Author: | Sergey Esenov
Notes: |

2.2.0-2.1.12

Created: | 2017-06-12T15:43:27.000+02:00
Author: | esenov
Notes: |

###### TIMESERVER_BSTATS

### DAQ

[add component documentation]

#### DATA

[add component documentation]

##### DA

[add component documentation]

###### 1

Instance id: | SA2_DAQ_DATA/DA/1
Class id: | DataAggregator
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | SA2_DAQ_PBM, SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Scenes: | SA2_RUN_CONTROL_1_PBM-OBSOLETE, SA2_RUN_CONTROL_1_PBM, SA2_XTD1_UND-MDL-GAINCURVE_SCAN-scene, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 3

Instance id: | SA2_DAQ_DATA/DA/3
Class id: | DataAggregator
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Scenes: | SA2_RUN_CONTROL_1_PBM-OBSOLETE, SA2_XTD1_UND-MDL-GAINCURVE_SCAN-scene, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### 4

Instance id: | SA2_DAQ_DATA/DA/4
Class id: | DataAggregator
Host: | sa2-br-sys-daq-srv2
Alias: | sa2-br-sys-daq-srv2
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Scenes: | SA2_RUN_CONTROL_2_COMM-OBSOLETE, SA2_RUN_CONTROL_2_COMM_v2-OBSOLETE, MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

##### DM

[add component documentation]

###### CAL_REMOTE_0

###### CAL_REMOTE_1

###### CAL_REMOTE_2

###### CAL_REMOTE_3

###### CAL_REMOTE_4

###### CAL_REMOTE_5

###### CAL_REMOTE_6

###### CAL_REMOTE_7

###### CONFIGURATOR_1

Instance id: | SA2_DAQ_DATA/DM/CONFIGURATOR_1
Class id: | RunConfigurator
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Projects: | SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|scene, SA2_RUN_CONTROL_1_PBM-OBSOLETE, SA2_RUN_CONTROL_1_PBM, SA2_PBM_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, SA2_PBM_RUN_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- configurations:
    All configuration groups and their sources
- sources:
    Overall list of data sources and their attributes

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### CONFIGURATOR_2

Instance id: | SA2_DAQ_DATA/DM/CONFIGURATOR_2
Class id: | RunConfigurator
Host: | sa2-br-sys-daq-srv2
Alias: | sa2-br-sys-daq-srv2
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_RUN_CONTROL_2_COMM-OBSOLETE, SA2_DAQ_DATA/DM/CONFIGURATOR_2|scene, SA2_RUN_CONTROL_2_COMM_v2-OBSOLETE, SA2_COMM_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, SA2_COMM_RUN_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- configurations:
    All configuration groups and their sources
- sources:
    Overall list of data sources and their attributes

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### DATA_MANAGER_1

Instance id: | SA2_DAQ_DATA/DM/DATA_MANAGER_1
Class id: | DataManager
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Resets the device in case of an error
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- instrumentsList:
    List of instruments for this DAQ instance (e.g FXE,SA1)!
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runNumber:
    Current run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### DATA_MANAGER_2

Instance id: | SA2_DAQ_DATA/DM/DATA_MANAGER_2
Class id: | DataManager
Host: | sa2-br-sys-daq-srv2
Alias: | sa2-br-sys-daq-srv2
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Resets the device in case of an error
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- instrumentsList:
    List of instruments for this DAQ instance (e.g FXE,SA1)!
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runNumber:
    Current run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### DSG_REPORT_1

Instance id: | SA2_DAQ_DATA/DM/DSG_REPORT_1
Class id: | ReportConfigGroups
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/karaboDevices/checkConfigGroups
Last modified: | 2021-09-19T11:41:51.075+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.2-2.5.0
Deployment tag: | 2.2.2-2.5.0
Projects: | SA2_CHECK_CONFIG_GROUPS, SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Scenes: | EMAIL_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS_OBSOLETE, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- diffResult:
    Diff Results
- topicId:
    Topic identifier used by this device
- filenameId:
    Name of the file generated and send by email
- emailToId:
    Email to where the report should be send

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### GAIN_CURVE_AUX_GROUP

Instance id: | SA2_DAQ_DATA/DM/GAIN_CURVE_AUX_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/GAIN_CURVE_AUX_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### GAIN_CURVE_GROUP

Instance id: | SA2_DAQ_DATA/DM/GAIN_CURVE_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/GAIN_CURVE_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### GAIN_CURVE_SCAN_GROUP

Instance id: | SA2_DAQ_DATA/DM/GAIN_CURVE_SCAN_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/GAIN_CURVE_SCAN_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HED_IPM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HED_IPM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HED_TUNNEL_CAMERAS_GROUP

Instance id: | SA2_DAQ_DATA/DM/HED_TUNNEL_CAMERAS_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HED_XTD6_IMGPI_GROUP

Instance id: | SA2_DAQ_DATA/DM/HED_XTD6_IMGPI_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/HED_XTD6_IMGPI_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HED_XTD6_MIRRORS_GROUP

Instance id: | SA2_DAQ_DATA/DM/HED_XTD6_MIRRORS_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_BRAGG_COMM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_BRAGG_COMM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_BRAGG_PBM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_BRAGG_PBM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_DETECTOR_CAM_COMM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_DETECTOR_CAM_COMM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_GOTT_COMM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_GOTT_COMM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_MOTOR_COMM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_MOTOR_COMM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### MDC_REMOTE_1

Instance id: | SA2_DAQ_DATA/DM/MDC_REMOTE_1
Class id: | MetadataDBRemote
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/metadataDBRemote
Last modified: | 2021-06-23T14:42:53.000+02:00
Created at: | 2017-03-02T16:11:47.000+01:00
Main authors: | Maia, Hauf
Latest tag: | 3.3.0-2.11.1
Deployment tag: | 3.3.0-2.11.1
Projects: | SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- client_email:
    Metadata Catalogue Client User email address
- client_id:
    Metadata Catalogue User Oauth identifier
- client_secret:
    Metadata Catalogue User Oauth secret
- metadata_application_url:
    Metadata Catalogue application Web Url

Release History
3.3.0-2.11.1

Created: | 2021-06-23T14:55:12.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created: | 2021-06-18T14:42:04.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created: | 2021-06-04T15:22:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created: | 2021-06-03T17:17:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created: | 2021-06-03T03:39:27.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created: | 2021-06-02T22:52:53.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created: | 2021-06-02T12:57:58.000+02:00
Author: | Nasser Al-Qudami
Notes: |

3.0.7-2.9.2

Created: | 2020-06-30T22:51:41.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created: | 2020-06-11T10:48:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created: | 2019-08-23T08:12:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created: | 2019-08-23T00:53:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created: | 2019-08-16T15:26:20.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created: | 2017-12-21T15:52:41.000+01:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created: | 2017-12-21T09:32:55.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created: | 2017-12-20T11:48:53.000+01:00
Author: | Luis Maia
Notes: | In this tag: * Release version 1.1.5-2.1.18 * Update MetadataClient to 1.1.4.1 * Comment issue that prevents device installation via Ansible

1.1.4-2.1.16

Created: | 2017-11-10T14:19:21.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created: | 2017-09-13T20:17:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created: | 2017-09-04T18:42:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.1-2.1.12

###### MDC_REMOTE_2

Instance id: | SA2_DAQ_DATA/DM/MDC_REMOTE_2
Class id: | MetadataDBRemote
Host: | sa2-br-sys-daq-srv2
Alias: | sa2-br-sys-daq-srv2
Git repo: | https://git.xfel.eu/karaboDevices/metadataDBRemote
Last modified: | 2021-06-23T14:42:53.000+02:00
Created at: | 2017-03-02T16:11:47.000+01:00
Main authors: | Maia, Hauf
Latest tag: | 3.3.0-2.11.1
Deployment tag: | 3.3.0-2.11.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- client_email:
    Metadata Catalogue Client User email address
- client_id:
    Metadata Catalogue User Oauth identifier
- client_secret:
    Metadata Catalogue User Oauth secret
- metadata_application_url:
    Metadata Catalogue application Web Url

Release History
3.3.0-2.11.1

Created: | 2021-06-23T14:55:12.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created: | 2021-06-18T14:42:04.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created: | 2021-06-04T15:22:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created: | 2021-06-03T17:17:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created: | 2021-06-03T03:39:27.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created: | 2021-06-02T22:52:53.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created: | 2021-06-02T12:57:58.000+02:00
Author: | Nasser Al-Qudami
Notes: |

3.0.7-2.9.2

Created: | 2020-06-30T22:51:41.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created: | 2020-06-11T10:48:57.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created: | 2020-01-27T12:14:04.000+01:00
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created: | 2019-08-23T08:12:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created: | 2019-08-23T00:53:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created: | 2019-08-16T15:26:20.000+02:00
Author: | Luis Maia
Notes: | Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created: | 2017-12-21T15:52:41.000+01:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created: | 2017-12-21T09:32:55.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created: | 2017-12-20T11:48:53.000+01:00
Author: | Luis Maia
Notes: | In this tag: * Release version 1.1.5-2.1.18 * Update MetadataClient to 1.1.4.1 * Comment issue that prevents device installation via Ansible

1.1.4-2.1.16

Created: | 2017-11-10T14:19:21.000+01:00
Author: | Luis Maia
Notes: | Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created: | 2017-09-13T20:17:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created: | 2017-09-04T18:42:01.000+02:00
Author: | Luis Maia
Notes: | Release tag 1.1.1-2.1.12

###### MID_AUXT2_IMGPI_GROUP

Instance id: | SA2_DAQ_DATA/DM/MID_AUXT2_IMGPI_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/MID_AUXT2_IMGPI_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### MID_XTD6_BMPI-1_GROUP

Instance id: | SA2_DAQ_DATA/DM/MID_XTD6_BMPI-1_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/MID_XTD6_BMPI-1_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### MID_XTD6_BMPI-2_GROUP

Instance id: | SA2_DAQ_DATA/DM/MID_XTD6_BMPI-2_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/MID_XTD6_BMPI-2_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### MID_XTD6_IMGPI_GROUP

Instance id: | SA2_DAQ_DATA/DM/MID_XTD6_IMGPI_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/MID_XTD6_IMGPI_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### RUN_CONTROL_1

Instance id: | SA2_DAQ_DATA/DM/RUN_CONTROL_1
Class id: | RunController
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Projects: | SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Scenes: | SA2_RUN_CONTROL_1_PBM-OBSOLETE, SA2_RUN_CONTROL_1_PBM, SA2_PBM_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, SA2_PBM_RUN_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Controller:
    Main controller
- slotPushToDaq:
    Push run configuration to DAQ
- slotRetrieveProposalDetails:
    Retrieve proposal details
- actions:
    Actions
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- alias:
    Device alias
- defaultMaxSize:
    Default max size for vectors when this is not specified in data schema
- runConfigurator:
    Run configurator
- dataManager:
    Data manager device
- metadataSchemaVersion:
    Metadata schema version
- proposalNumber:
    Proposal number
- proposalTitle:
    Proposal title
- proposalInstrument:
    Proposal instrument
- proposalDataPath:
    Proposal data path
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runMsg:
    Run message
- runNumber:
    Run number
- runDetails:
    Run details
- trainId:
    Current Train Id(landmark)
- refTrainId:
    Method and offset for calculating the reference Train Id
- globalState:
    Global state details
- aggregators:
    Aggregators devices
- dataSourceToAggregatorsMapping:
    Data sources to aggregators mapping
- debug:
    Debug mode
- policy:
    Errors handling policy
- dataAggregatorsSpec:
    Data aggregators specification
- dataAggregators:
    Data aggregators

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### RUN_CONTROL_2

Instance id: | SA2_DAQ_DATA/DM/RUN_CONTROL_2
Class id: | RunController
Host: | sa2-br-sys-daq-srv2
Alias: | sa2-br-sys-daq-srv2
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Scenes: | SA2_RUN_CONTROL_2_COMM-OBSOLETE, SA2_RUN_CONTROL_2_COMM_v2-OBSOLETE, SA2_COMM_RUN_CONTROL_GLOBAL_STATE_OBSOLETE, SA2_COMM_RUN_CONTROL_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Controller:
    Main controller
- slotPushToDaq:
    Push run configuration to DAQ
- slotRetrieveProposalDetails:
    Retrieve proposal details
- actions:
    Actions
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- alias:
    Device alias
- defaultMaxSize:
    Default max size for vectors when this is not specified in data schema
- runConfigurator:
    Run configurator
- dataManager:
    Data manager device
- metadataSchemaVersion:
    Metadata schema version
- proposalNumber:
    Proposal number
- proposalTitle:
    Proposal title
- proposalInstrument:
    Proposal instrument
- proposalDataPath:
    Proposal data path
- experiment:
    Experiment
- sample:
    Sample
- dataType:
    Data type
- runMsg:
    Run message
- runNumber:
    Run number
- runDetails:
    Run details
- trainId:
    Current Train Id(landmark)
- refTrainId:
    Method and offset for calculating the reference Train Id
- globalState:
    Global state details
- aggregators:
    Aggregators devices
- dataSourceToAggregatorsMapping:
    Data sources to aggregators mapping
- debug:
    Debug mode
- policy:
    Errors handling policy
- dataAggregatorsSpec:
    Data aggregators specification
- dataAggregators:
    Data aggregators

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

###### SA2_BEAM_COND_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_BEAM_COND_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/SA2_BEAM_COND_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_DOOCS_MONITORS_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_DOOCS_MONITORS_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_GAIN_STUDY_1_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_GAIN_STUDY_1_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_GAIN_STUDY_2_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_GAIN_STUDY_2_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_SCANTOOL_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_SCANTOOL_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_UND_DOOCS_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_UND_DOOCS_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-25T19:20:30.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Goeries
Latest tag: | deps-upgrade-boost168-mqtt
Deployment tag: | deps-upgrade-boost168-mqtt
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

2.10.0rc6

Created: | 2020-11-16T16:48:09.000Z
Author: | Cammille Carinan
Notes: | 6-th Release Candidate for 2.10

2.10.0

Created: | 2020-11-16T16:48:09.000Z
Author: | Cammille Carinan
Notes: | Karabo version 2.10.0 The most relevant improvements, fixes and changes are: Core Functionality: A ConfigurationManager has been added to the framework, offering a new way to manage device configurations (Minimum Viable Product state) GUI: - The Karabo GUI is shipped now with open license fonts to ensure uniformity across the three supported platforms Linux, Windows and MacOS: Source Sans Pro, Source Serif Pro, Source Code Pro. All other fonts won’t be offered anymore. The configurator panel validates when configurations are retrieved from history, configuration DB or loaded from XML files. The layouts geometry are respecting the SVG backend This is an essential step to display Karabo Scenes in a Browser with the web interface. For this reason, we ask everyone to update their KaraboGUI client. Deprecations: the grid layout won’t be offered anymore on grouping, the DoubleWheelEdit controller has been deprecated, the Slider widget has been deprecated. Input-/OutputChannel Pipelines: - All APIs: The available options of the onSlowness parameter that defines how an output channel should react if a connected input channel is not yet ready to receive more data, have changed: * The non-functional `throw` has been removed and a new option `queueDrop` has been introduced (Minimum Viable Product state). The default has changed from `wait` to `drop`. MDL OutputChannel offers writeEndOfStream. MDL: - Every requiredAccessLevel which will be at least AccessLevel.USER for reconfigurable parameters if not explicitly specified. The event loop can be configured and set to uvLoop (https://github.com/MagicStack/uvloop) C++ API - C++/bound: The legacy point-to-point shortcut for broker type communication has been removed. (source of Data Logger inconsistencies for Karabo < 2.9) See https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.10.html for more details.

2.10.0rc5

Created: | 2020-11-13T10:35:39.000Z
Author: | Dennis Goeries
Notes: | 5th RC for 2.10.0

2.10.0rc4

Created: | 2020-11-11T18:10:00.000Z
Author: | Cammille Carinan
Notes: | 4-th release candidate of 2.10.0

2.10.0rc3

Created: | 2020-11-10T16:48:35.000Z
Author: | Dennis Goeries
Notes: | 3rd release candidate of 2.10

2.10.0rc2

Created: | 2020-11-06T16:41:13.000Z
Author: | Dennis Goeries
Notes: | 2nd release candidate of 2.10

2.10.0rc1

Created: | 2020-11-04T17:01:01.000Z
Author: | Alessandro Silenzi
Notes: | First release candidate of 2.10.0

deps-rm-mqtt-downgradeboost

Created: | 2020-11-04T10:38:01.000Z
Author: | Cammille Carinan
Notes: |

2.10.0a26

Created: | 2020-10-30T15:10:56.000Z
Author: | Dennis Goeries
Notes: |

deps-upgrade-boostcpp14

Created: | 2020-10-28T14:50:56.000Z
Author: | Raul Costa
Notes: |

deps-upgrade-qwt

Created: | 2020-10-27T18:34:03.000Z
Author: | Raul Costa
Notes: |

deps-add-mqtt_cmake

Created: | 2020-10-27T18:34:03.000Z
Author: | Raul Costa
Notes: |

2.10.0a25

Created: | 2020-10-23T13:45:17.000Z
Author: | Dennis Goeries
Notes: | weekly release

2.10.0a24

Created: | 2020-10-16T23:58:16.000Z
Author: | Dennis Goeries
Notes: |

2.10.0a23

Created: | 2020-10-16T16:16:08.000Z
Author: | Cammille Carinan
Notes: |

2.10.0a22

Created: | 2020-10-09T13:52:57.000Z
Author: | Dennis Goeries
Notes: |

2.10.0a21

Created: | 2020-10-02T08:18:40.000Z
Author: | Dennis Goeries
Notes: | Weekly release

deps-add-centos8

Created: | 2020-09-29T19:41:22.000Z
Author: | Alessandro Silenzi
Notes: | Adding CentOS8 to the builds

2.10.0a20

Created: | 2020-09-29T06:13:38.000Z
Author: | Alessandro Silenzi
Notes: | Weekly release

###### SA2_XTD1_IMGFEL_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD1_IMGFEL_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD1_KMONO_IMG_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD1_KMONO_IMG_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD1_KMONO_PD_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD1_KMONO_PD_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD6_IMGPII45-1_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD6_IMGPII45-1_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/SA2_XTD6_IMGPII45-1_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD6_IMGPII45-2_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD6_IMGPII45-2_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/SA2_XTD6_IMGPII45-2_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD6_MCP_X1_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD6_MCP_X1_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/SA2_XTD6_MCP_X1_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD6_MCP_X2_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD6_MCP_X2_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Scenes: | SA2_DAQ_DATA/DM/SA2_XTD6_MCP_X2_GROUP|scene, SA2_DAQ_DATA/DM/CONFIGURATOR_1|link
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### checkConfigGroups

Instance id: | SA2_DAQ_DATA/DM/checkConfigGroups
Class id: | CheckConfigGroups
Host: | exflcon92n0
Alias: | hed-br-sys-daq-dsg1 , mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/checkConfigGroups
Last modified: | 2020-11-22T19:29:52.000+01:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Tirumalai, Al-qudami
Latest tag: | 2.1.0-2.5.0
Deployment tag: | 2.1.0-2.5.0
Projects: | SA2_CHECK_CONFIG_GROUPS, SA2_DAQ_RUN_MGMT_PBM, SA2_MAIN_copy
Scenes: | EMAIL_COFIGURATION_GROUPS, CHECK_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS, CHECK_COFIGURATION_GROUPS_COMM, CHECK_COFIGURATION_GROUPS_PBM, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- 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.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: |

1.1.0-2.2.2

Created: | 2018-03-29T09:10:53.000Z
Author: | Nasser Al-Qudami
Notes: |

1.0.9-2.2.2

Created: | 2018-03-29T07:43:06.000Z
Author: | Nasser Al-Qudami
Notes: |

1.0.8-2.2.2

Created: | 2018-03-28T16:45:17.000Z
Author: | Nasser Al-Qudami
Notes: |

1.0.7-2.2.2

Created: | 2018-03-28T16:34:12.000Z
Author: | Nasser Al-Qudami
Notes: |

###### SA2_XTD1_IMGTR_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD1_IMGTR_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### checkConfigGroups_1

Instance id: | SA2_DAQ_DATA/DM/checkConfigGroups_1
Class id: | CheckConfigGroups
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/karaboDevices/checkConfigGroups
Last modified: | 2021-09-19T11:41:51.075+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.2-2.5.0
Deployment tag: | 2.2.2-2.5.0
Scenes: | CHECK_COFIGURATION_GROUPS_PBM, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- availableGroups:
    Avialable groups
- scanGroupsResult:
    Scan Results
- configuratorId:
    DAQ CONFIGURATOR device Id
- timeServerId:
    A timeServerId to get a trainId
- recentTrainId:
    Most recently published train ID from timeServer
- trainIdThreshold:
    Threshold for trainId
- checkTrainIdFrom:
    Return TrainId from device slot/configuration

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### checkConfigGroups_2

Instance id: | SA2_DAQ_DATA/DM/checkConfigGroups_2
Class id: | CheckConfigGroups
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/karaboDevices/checkConfigGroups
Last modified: | 2021-09-19T11:41:51.075+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.2-2.5.0
Deployment tag: | 2.2.2-2.5.0
Scenes: | CHECK_COFIGURATION_GROUPS_COMM
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- availableGroups:
    Avialable groups
- scanGroupsResult:
    Scan Results
- configuratorId:
    DAQ CONFIGURATOR device Id
- timeServerId:
    A timeServerId to get a trainId
- recentTrainId:
    Most recently published train ID from timeServer
- trainIdThreshold:
    Threshold for trainId
- checkTrainIdFrom:
    Return TrainId from device slot/configuration

Release History
2.2.2-2.5.0

Created: | 2021-07-08T18:01:02.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.1-2.5.0

Created: | 2021-06-28T21:45:57.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T14:34:36.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T17:02:14.000+02:00
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T16:39:58.000+02:00
Author: | Nasser Al-Qudami
Notes: | In this tag: - Adding a new feature slotGetTime to support karabo 2.5.0 - Adding Timestamp to the result summary so can easily identified - Ability to check the data source trainId from the device configuration / slotGetTime - Throw exception if the data source still running under older karabo version - Adding timeout for blocking slot call to avoiding stall if the device is not responsive - The default check set to use a device configuration to check the trainId - It supports backward compatibility - The source code is based on 2.0.8.1-2.4.0

2.0.8.1-2.4.0

Created: | 2019-04-17T17:54:16.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T10:08:53.000+02:00
Author: | Nasser Al-Qudami
Notes: | Checking the trainId for the output channel defined within a data source device.

2.0.8-2.3.0

Created: | 2019-01-31T17:58:06.000+01:00
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T12:36:28.000+01:00
Author: | Nasser Al-Qudami
Notes: | This version contains a bug fix for the group which is listed in CONFIGURATOR but instanceId is not instantiated or not up!

2.0.6-2.3.0

Created: | 2019-01-28T16:23:50.000+01:00
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T10:40:18.000+01:00
Author: | Nasser Al-Qudami
Notes: | Fixing the int type conversion in the checkConfigGroup device for python 3.6.6 that comes with karabo 2.3.2 version.

2.0.4-2.2.6

Created: | 2018-10-22T15:51:35.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T14:55:29.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-25T01:22:08.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T23:00:46.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T16:17:44.000+02:00
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T11:43:32.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T11:36:38.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T11:31:23.000+02:00
Author: | Nasser Al-Qudami
Notes: |

###### DOOCS_BAM_GROUP

Instance id: | SA2_DAQ_DATA/DM/DOOCS_BAM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_XTD1_UND_DOOCS_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_XTD1_UND_DOOCS_GROUP
Class id: | RunConfigurationGroup
Host: | exflcon92n0
Alias: | mid-br-sys-daq-dsg1 , sa2-br-sys-daq-dsg1 , hed-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2020-11-30T18:34:35.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Silenzi, Flucke
Latest tag: | 2.11.0a1
Deployment tag: | 2.11.0a1
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.0a1

Created: | 2020-11-27T16:26:20.000Z
Author: | Gero Flucke
Notes: | 1st alpha for 2.11.0

deps-upgrade-boost168-mqtt

Created: | 2020-11-25T13:33:26.000Z
Author: | Sergey Esenov
Notes: |

2.10.0rc6

Created: | 2020-11-16T16:48:09.000Z
Author: | Cammille Carinan
Notes: | 6-th Release Candidate for 2.10

2.10.0

Created: | 2020-11-16T16:48:09.000Z
Author: | Cammille Carinan
Notes: | Karabo version 2.10.0 The most relevant improvements, fixes and changes are: Core Functionality: A ConfigurationManager has been added to the framework, offering a new way to manage device configurations (Minimum Viable Product state) GUI: - The Karabo GUI is shipped now with open license fonts to ensure uniformity across the three supported platforms Linux, Windows and MacOS: Source Sans Pro, Source Serif Pro, Source Code Pro. All other fonts won’t be offered anymore. The configurator panel validates when configurations are retrieved from history, configuration DB or loaded from XML files. The layouts geometry are respecting the SVG backend This is an essential step to display Karabo Scenes in a Browser with the web interface. For this reason, we ask everyone to update their KaraboGUI client. Deprecations: the grid layout won’t be offered anymore on grouping, the DoubleWheelEdit controller has been deprecated, the Slider widget has been deprecated. Input-/OutputChannel Pipelines: - All APIs: The available options of the onSlowness parameter that defines how an output channel should react if a connected input channel is not yet ready to receive more data, have changed: * The non-functional `throw` has been removed and a new option `queueDrop` has been introduced (Minimum Viable Product state). The default has changed from `wait` to `drop`. MDL OutputChannel offers writeEndOfStream. MDL: - Every requiredAccessLevel which will be at least AccessLevel.USER for reconfigurable parameters if not explicitly specified. The event loop can be configured and set to uvLoop (https://github.com/MagicStack/uvloop) C++ API - C++/bound: The legacy point-to-point shortcut for broker type communication has been removed. (source of Data Logger inconsistencies for Karabo < 2.9) See https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.10.html for more details.

2.10.0rc5

Created: | 2020-11-13T10:35:39.000Z
Author: | Dennis Goeries
Notes: | 5th RC for 2.10.0

2.10.0rc4

Created: | 2020-11-11T18:10:00.000Z
Author: | Cammille Carinan
Notes: | 4-th release candidate of 2.10.0

2.10.0rc3

Created: | 2020-11-10T16:48:35.000Z
Author: | Dennis Goeries
Notes: | 3rd release candidate of 2.10

2.10.0rc2

Created: | 2020-11-06T16:41:13.000Z
Author: | Dennis Goeries
Notes: | 2nd release candidate of 2.10

2.10.0rc1

Created: | 2020-11-04T17:01:01.000Z
Author: | Alessandro Silenzi
Notes: | First release candidate of 2.10.0

deps-rm-mqtt-downgradeboost

Created: | 2020-11-04T10:38:01.000Z
Author: | Cammille Carinan
Notes: |

2.10.0a26

Created: | 2020-10-30T15:10:56.000Z
Author: | Dennis Goeries
Notes: |

deps-upgrade-boostcpp14

Created: | 2020-10-28T14:50:56.000Z
Author: | Raul Costa
Notes: |

deps-upgrade-qwt

Created: | 2020-10-27T18:34:03.000Z
Author: | Raul Costa
Notes: |

deps-add-mqtt_cmake

Created: | 2020-10-27T18:34:03.000Z
Author: | Raul Costa
Notes: |

2.10.0a25

Created: | 2020-10-23T13:45:17.000Z
Author: | Dennis Goeries
Notes: | weekly release

2.10.0a24

Created: | 2020-10-16T23:58:16.000Z
Author: | Dennis Goeries
Notes: |

2.10.0a23

Created: | 2020-10-16T16:16:08.000Z
Author: | Cammille Carinan
Notes: |

2.10.0a22

Created: | 2020-10-09T13:52:57.000Z
Author: | Dennis Goeries
Notes: |

2.10.0a21

Created: | 2020-10-02T08:18:40.000Z
Author: | Dennis Goeries
Notes: | Weekly release

deps-add-centos8

Created: | 2020-09-29T19:41:22.000Z
Author: | Alessandro Silenzi
Notes: | Adding CentOS8 to the builds

###### BUNCHPATTERN_GROUP

Instance id: | SA2_DAQ_DATA/DM/BUNCHPATTERN_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### HIREX_GOTT_CAL_COMM_GROUP

Instance id: | SA2_DAQ_DATA/DM/HIREX_GOTT_CAL_COMM_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_DOC_ADHOC_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

###### SA2_DOOCS_UNDULATOR_GROUP

Instance id: | SA2_DAQ_DATA/DM/SA2_DOOCS_UNDULATOR_GROUP
Class id: | RunConfigurationGroup
Host: | sa2-br-sys-daq-dsg1
Alias: | sa2-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/Karabo/Framework
Last modified: | 2021-10-07T16:45:42.947+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Goeries, Costa
Latest tag: | 2.12.0rc2
Deployment tag: | 2.12.0rc2
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.12.0rc2

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | 2nd release candidate of 2.12.0

2.12.0

Created: | 2021-09-29T14:00:53.000+02:00
Author: | Alessandro Silenzi
Notes: | Release of the Karabo Framework 2.12. It will be future compatible with 2.13 and contains significant improvements over 2.11.

2.12.0rc1

Created: | 2021-09-27T15:58:05.000+02:00
Author: | Gero Flucke
Notes: | 1st release candidate of 2.12.0

2.12.0a10

Created: | 2021-09-15T14:44:02.000+02:00
Author: | Dennis Goeries
Notes: |

deps-update-redisclient102dev

Created: | 2021-09-15T08:51:47.000+02:00
Author: | Raul Costa
Notes: | Update the redis client

2.12.0a9

Created: | 2021-08-24T11:16:33.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a8

Created: | 2021-08-23T11:54:12.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a7

Created: | 2021-08-13T18:29:03.000+02:00
Author: | Alessandro Silenzi
Notes: |

2.12.0a6

Created: | 2021-08-13T11:40:40.000+02:00
Author: | Gero Flucke
Notes: |

deps-add-amqp

Created: | 2021-08-06T15:19:37.000+02:00
Author: | Sergey Esenov
Notes: |

2.11.4rc1

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | First rc of 2.11.4

2.11.4

Created: | 2021-07-21T17:31:29.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: Drop early data on InfluxDb GUI: Enable to subclass table widgets for filter models and set item model to None

2.11.3

Created: | 2021-07-09T12:42:52.000+02:00
Author: | Dennis Goeries
Notes: |

2.12.0a5

Created: | 2021-07-09T12:13:14.000+02:00
Author: | Sergey Esenov
Notes: |

deps-add-multiBrokerDeps

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: |

2.12.0a4

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Same as 2.12.0a3

2.12.0a3

Created: | 2021-07-07T13:49:07.000+02:00
Author: | Gero Flucke
Notes: | Experimental branch with many brokers

2.11.2

Created: | 2021-06-29T14:30:20.000+02:00
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T17:14:20.000+02:00
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T19:53:47.000+02:00
Author: | Dennis Goeries
Notes: |

##### MDL

[add component documentation]

###### CONNECTION_CHECK_1

###### CONNECTION_CHECK_2

##### DOC

[add component documentation]

###### 1

Instance id: | SA2_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | sa2-br-sys-daq-srv1
Alias: | sa2-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/karaboDevices/pcLayer
Last modified: | 2021-10-07T10:47:05.637+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Al-qudami, Boukhelef
Latest tag: | 1.11.0-2.11.4ra0
Deployment tag: | 1.11.0-2.11.4ra0
Scenes: | MONITORING_DAs_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reset:
    Reset
- version:
    Software version
- lastStatusMessage:
    Status message of last command
- loggerConfig:
    Runtime logger configuration
- policy:
    Errors handling policy
- ApplicationMonitor:
    Application health monitor
- BookKeeper:
    Book keeper
- BufferManager:
    Buffer manager
- DataAccessor0:
    Data accessor 0
- DataAccessor1:
    Data accessor 1
- DataDispatcher:
    Data dispatcher
- DataIntegrator:
    Data integrator
- DataMonitor:
    Data content monitor
- FastDataCollector:
    Fast data collector
- Formatter:
    Formatter
- InternalTrigger:
    Internal trigger
- MessageLogger:
    Message logger
- PreProcessor:
    Pre processor
- Scheduler:
    Scheduler
- SlowDataCollector:
    Slow data collector
- StatisticsBuilder:
    Statistics builder
- Summarizer:
    Data summarizer
- TrainDataReceiver:
    Train data receiver
- TrainReconstructor:
    Train data reconstructor
- Vectorizer:
    Data vectorizer
- Writer:
    Writer
- enableDaqNode:
    Enable DAQ node
- storageManager:
    Storage manager device
- alias:
    Device alias
- groupId:
    Aggregators group Id
- groupInfix:
    Aggregators group infix
- channelId:
    channel Id
- channelsCount:
    Number of channels
- mountPoint:
    Mount point
- dataPath:
    Proposal data path
- chunkSize:
    Number of trains to buffer in memory
- chunksCount:
    Chunk count per file
- maxExpectedPulses:
    Maximum number of pulses expected per train
- dataType:
    Data type
- runController:
    Run controller
- experimentDetails:
    Experiment details
- sampleDetails:
    Sample details
- runDetails:
    Run details
- enableXTDF:
    Enable receiving train data via UDP
- OriginalDataFormat:
    Name of file that contains the original data format description, include train data format, dataset and run info.
- Detector:
    Name of file that contains the detector configuration.
- metrics:
    Heath and performance metrics

Release History
1.11.0-2.11.4ra0

Created: | 2021-09-28T14:01:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.5-2.11.4rc1

Created: | 2021-09-24T08:56:29.000+00:00
Author: | Geogin Varghese
Notes: | pclayer release candidate 1 for Karabo 2.11 support

1.10.4-2.10.5

Created: | 2021-07-05T16:34:28.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release PC Layer 1.10.4-2.10.5

1.10.3-2.10.5

Created: | 2021-06-28T09:58:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T08:12:26.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC layer 1.10.3-2.10.5-rc2

1.10.3-2.10.5-rc1

Created: | 2021-06-24T01:21:52.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-21T01:03:13.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T07:48:22.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T23:44:24.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T16:22:33.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T14:53:52.000+02:00
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T18:06:16.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T12:39:31.000+02:00
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T14:25:23.000+02:00
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T08:29:43.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T18:06:03.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T10:36:11.000+02:00
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T17:43:49.000+02:00
Author: | Alessandro Silenzi
Notes: | This tag is create from “rm_85521” for testing purpose to proceed with deployment and installations.

1.10.2-2.10.0-rx0

Created: | 2021-04-30T02:26:16.000+02:00
Author: | Djelloul Boukhelef
Notes: |

### HED

[add component documentation]

#### DOOCS

[add component documentation]

##### PBLM

[add component documentation]

###### 3302L

###### 3302R

### MID

[add component documentation]

#### DOOCS

[add component documentation]

##### PBLM

[add component documentation]

###### 3222L

###### 3222R

### SYS

[add component documentation]

#### EPS2MPS

[add component documentation]

##### DCTRL

[add component documentation]

###### MODE1

Instance id: | SA2_SYS_EPS2MPS/DCTRL/MODE1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODE1_INTERLOCK, SA2_EPS2MPS, SA2_EPS2MPS, BunchPatternServerS2, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODE1_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MODEF

Instance id: | SA2_SYS_EPS2MPS/DCTRL/MODEF
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK, SA2_EPS2MPS, SA2_EPS2MPS, BunchPatternServerS2, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_old, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MODEM

Instance id: | SA2_SYS_EPS2MPS/DCTRL/MODEM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODEM_INTERLOCK, SA2_EPS2MPS, SA2_EPS2MPS, SA2_EPS2MPS, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, BunchPatternServerS2, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_old, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEM_INTERLOCK_old, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODEM_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MODES

Instance id: | SA2_SYS_EPS2MPS/DCTRL/MODES
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_EPS2MPS, SA2_EPS2MPS, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, BunchPatternServerS2, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODEM_INTERLOCK_old, SA2_EPS2MPS, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODEM_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SHUT_XS2_ACLOSE

Instance id: | SA2_SYS_EPS2MPS/DCTRL/SHUT_XS2_ACLOSE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_SHUT_XS2_ACLOSE_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_SHUT_XS2_ACLOSE_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20000M_PNACT_CLOSE

Instance id: | SA2_SYS_EPS2MPS/DCTRL/V20000M_PNACT_CLOSE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_V20000M_PNACT_CLOSE_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_V20000M_PNACT_CLOSE_INTERLOCK
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### DOOCS

[add component documentation]

###### POD

Instance id: | SA2_SYS_EPS2MPS/DOOCS/POD
Class id: | DoocsPulseKicker
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.12-2.10.4
Accessible by: | CAL, 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.16-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- eventsTrigger:
    Number of fired Trigger
- setBunches:
    This slot will set given number of bunches to DOOCS and will stay at a given number
- acquisitionTime:
    The Interval between requesting bunches and then setting it to zero.
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- updateInterval:
    Polling Interval to get updated values from DOOCS
- start:
    This slot will set given number of Bunches to DOOCS and after waiting interval(i.e. acquisitionTime) it will set back to zero
- stop:
    This slot will only set zero to DOOCS if start command is not finished. This command will be void if start commands was not executed or was already completed
- beamLine:
    Beam Line

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T08:05:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

#### VAC2MPS

[add component documentation]

##### DCTRL

[add component documentation]

###### SA2_VAC_OK

Instance id: | SA2_SYS_VAC2MPS/DCTRL/SA2_VAC_OK
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, MPS_TEST, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, TURBO_FAILURE, BiancaTest2, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

### UND

[add component documentation]

#### DOOCS

[add component documentation]

##### MDL

[add component documentation]

###### BCM205_B1

###### BCM416_B2

###### BEAM_ENERGY

###### BPME_2252

###### BPME_2300

###### GUN_PHASE

###### TORA_2228

###### TORA_25

##### DIRECTOR

### WATCHDOG

[add component documentation]

#### MDL

[add component documentation]

##### UNDULATORS

Instance id: | SA2_WATCHDOG/MDL/UNDULATORS
Class id: | GenericEstimator
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2020-07-28T10:53:16.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Mamchyk
Latest tag: | 1.0.8-2.9.1-test
Deployment tag: | 1.0.8-2.9.1-test
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

###### Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

###### Release History

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

0.0.3-2.6.1

Created: | 2019-09-26T16:51:16.000Z
Author: | Denys Mamchyk
Notes: | estimator+actuator version to be tested, created from branch

0.0.1-2.6.1

Created: | 2019-09-19T09:14:44.000Z
Author: | Denys Mamchyk
Notes: | Initial tag for testing, created from branch. Once MR is completed, create a tag from master

0.0.2-2.5.0

Created: | 2019-08-21T17:57:29.000Z
Author: | Denys Mamchyk
Notes: | Fix for parsing shortcuts (created from branch, only for testing)

0.0.1-2.5.0

Created: | 2019-08-21T12:54:07.000Z
Author: | Denys Mamchyk
Notes: | initial version (only for test)

### XS2

[add component documentation]

#### SYS

[add component documentation]

##### SWITCH

[add component documentation]

###### C20504E_T1OK

Instance id: | SA2_XS2_SYS/SWITCH/C20504E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20504E_T2OK

Instance id: | SA2_XS2_SYS/SWITCH/C20504E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20504E_T3BALOK

Instance id: | SA2_XS2_SYS/SWITCH/C20504E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20504E_T3REDOK

Instance id: | SA2_XS2_SYS/SWITCH/C20504E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

### XSDU1

[add component documentation]

#### TOR

[add component documentation]

##### DOOCS

[add component documentation]

###### T5D

### XTD1

[add component documentation]

#### ATT

[add component documentation]

##### MDL

[add component documentation]

###### MAIN

##### PNACT

[add component documentation]

###### A1

Instance id: | SA2_XTD1_ATT/PNACT/A1
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A1_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A1_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A3

Instance id: | SA2_XTD1_ATT/PNACT/A3
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A3_SETUP, SA2_XTD1_ATT_PNACT_A3_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A4

Instance id: | SA2_XTD1_ATT/PNACT/A4
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A4_SETUP, SA2_XTD1_ATT_PNACT_A4_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A5

Instance id: | SA2_XTD1_ATT/PNACT/A5
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A5_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A5_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A6

Instance id: | SA2_XTD1_ATT/PNACT/A6
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT_PNACT_A6_SETUP, SA2_XTD1_ATT1, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A6_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A7

Instance id: | SA2_XTD1_ATT/PNACT/A7
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A7_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A7_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A8

Instance id: | SA2_XTD1_ATT/PNACT/A8
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT_PNACT_A8_SETUP, SA2_XTD1_ATT1, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A8_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A9

Instance id: | SA2_XTD1_ATT/PNACT/A9
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A9_SETUP, SA2_MAIN, SA2_XTD1_ATT1, SA2_XTD1_ATT_PNACT_A9_SETUP, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_HIREX_MAIN, SA2_XTD1_ATT1_test, SA2_HIREX_HED, SA2_HIREX_MAIN0, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### A1

Instance id: | SA2_XTD1_ATT/TSENS/A1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A3

Instance id: | SA2_XTD1_ATT/TSENS/A3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A4

Instance id: | SA2_XTD1_ATT/TSENS/A4
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A5

Instance id: | SA2_XTD1_ATT/TSENS/A5
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A6

Instance id: | SA2_XTD1_ATT/TSENS/A6
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A7

Instance id: | SA2_XTD1_ATT/TSENS/A7
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A8

Instance id: | SA2_XTD1_ATT/TSENS/A8
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### A9

Instance id: | SA2_XTD1_ATT/TSENS/A9
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_ATT, SA2_MAIN_copy
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1, SA2_XTD1_ATT_TEMPS, SA2_XTD1_ATT1_test, SA2_XTD1_ATT1_test2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLB1

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD1_COLB1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD1_COLB1/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### CRL

[add component documentation]

##### DCTRL

[add component documentation]

###### ALL_LENSES_OUT

Instance id: | SA2_XTD1_CRL/DCTRL/ALL_LENSES_OUT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### CRL

Instance id: | SA2_XTD1_CRL/MDL/CRL
Class id: | CompoundRefractiveLens
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/compoundRefractiveLens
Last modified: | 2021-05-27T15:24:47.000+02:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.3.0-2.11.0
Deployment tag: | 1.3.0-2.11.0
Scenes: | SA2_XTD1_CRL/MDL/CRL_TEST|scene, SA2_XTD1_CRL/MDL/CRL|scene, SA2_XTD1_CRL/MDL/CRL|scene simple, SA2_XTD1_CRL/MDL/CRL|scene really simple, SA2_XTD1_CRL/alingLenses, HED_XTD6_CRL-MDL-CRL-scene-really-simple
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- interlocks:
    Properties of the interlock sensors.

Release History
1.3.0-2.11.0

Created: | 2021-05-27T15:25:24.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.4-2.10.0

Created: | 2021-05-26T15:39:43.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor use EPS logic

1.2.3-2.10.0

Created: | 2020-11-23T18:18:18.000+01:00
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T17:04:07.000+01:00
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T15:04:45.000+01:00
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T13:21:31.000+01:00
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T16:08:12.000+01:00
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T14:50:06.000+01:00
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T11:54:51.000+01:00
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T22:49:17.000+02:00
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T11:58:18.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T16:56:11.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T13:46:49.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T13:28:02.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T20:01:36.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T16:52:56.000+02:00
Author: | Dennis Goeries
Notes: |

###### CRL_TEST

Instance id: | SA2_XTD1_CRL/MDL/CRL_TEST
Class id: | CompoundRefractiveLens
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/compoundRefractiveLens
Last modified: | 2020-11-23T18:18:12.000+01:00
Created at: | 2017-03-07T13:50:52.000+01:00
Main authors: | Hauf, Haufs, Schaffer
Latest tag: | 1.2.3-2.10.0
Deployment tag: | 1.2.3-2.10.0
Scenes: | SA2_XTD1_CRL/MDL/CRL_TEST|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- numRods:
    Turn on/off Rods of CRL
- photonEnergy:
    Device Id to read Photon Energy value
- wavelength:
    Wave Length
- positionTolerance:
    Position tolerance to identify material foils
- energyTolerance:
    Energy difference after which a new table is generated
- lastEnergy:
    The last energy setting where an lens setting was calculated.
- actualEnergy:
    This is the actual energy setting. If connected, the current lens setting and target is automaticallyrefreshed.
- mode:
    Safe mode or Normal mode
- desiredFocalLength:
    Provide a desired FocalLength
- availableScenes:
    Scenes from the Slit System
- findTarget:
    Calculates actuator positions for the desired lens setting
- moveTarget:
    Drives the lens package to the desired transmission
- interlocks:
    Properties of the interlock sensors.
- configurationName:
    Name of configuration to create. If blank, this will default to saving numerically. If this configuration already exists, the existing one will be overwritten. Do not use the name ‘master’, it is protected. Restrict to alphanumeric characters, and do not start with a number.
- createConfiguration:
    Create a new configuration with the given name, and creates slots to save and load parameters of this configuration. In addition, saves the current parameters in this configuration. If this configuration already exists, will have no effect.
- saveConfigtest1:
    Saves the configuration of the inserted positions of the lenses
- loadConfigtest1:
    Loads the configuration of the inserted positions of the lenses

Release History
1.2.3-2.10.0

Created: | 2020-11-23T17:18:18.000Z
Author: | Steffen Hauf
Notes: |

1.2.3-2.7.2

Created: | 2020-02-26T16:04:07.000Z
Author: | Robert Schaffer
Notes: | Fixed a case typo

1.2.2-2.7.2-test

Created: | 2020-02-26T14:04:45.000Z
Author: | Robert Schaffer
Notes: | To be tested at MID tunnel, and improved upon.

1.2.2-2.7.2

Created: | 2020-02-26T12:21:31.000Z
Author: | Robert Schaffer
Notes: | Uses interlocks for retracted positions, and allows movement commands while arms are in motion.

1.2.1-2.7.0-test

Created: | 2020-01-21T15:08:12.000Z
Author: | Robert Schaffer
Notes: | A tagged branch to be tested in XTD6. This allows local saving of parameters.

1.2.1-2.7.0

Created: | 2019-12-23T13:50:06.000Z
Author: | Wajid Ehsan
Notes: | Fix actual energy setter

1.2.0-2.7.0

Created: | 2019-12-13T10:54:51.000Z
Author: | Robert Schaffer
Notes: |

1.1.1-2.2.4-hotfix

Created: | 2018-10-08T20:49:17.000Z
Author: | MScholz
Notes: | Configuration of rods

1.1.1-2.2.4

Created: | 2018-07-20T09:58:18.000Z
Author: | Wajid Ehsan
Notes: | Refactor Scene

1.1.0-2.2.4

Created: | 2018-06-13T14:56:11.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.2.3

Created: | 2018-05-31T11:46:49.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.2.3

Created: | 2018-05-31T11:28:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.14

Created: | 2017-08-18T18:01:36.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.14

Created: | 2017-08-18T14:52:56.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CHAM_AX

###### CHAM_AY

###### CHAM_X

###### CHAM_Y

###### LENS10_X

###### LENS10_Y

###### LENS1_X

###### LENS1_Y

###### LENS2_X

###### LENS2_Y

###### LENS3_X

###### LENS3_Y

###### LENS4_X

###### LENS4_Y

###### LENS5_X

###### LENS5_Y

###### LENS6_X

###### LENS6_Y

###### LENS7_X

###### LENS7_Y

###### LENS8_X

###### LENS8_Y

###### LENS9_X

###### LENS9_Y

##### SWITCH

[add component documentation]

###### LENS10_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS10_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS10_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS10_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS1_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS1_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS2_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS2_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS3_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS3_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS4_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS4_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS5_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS5_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS6_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS6_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS7_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS7_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS8_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS8_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_OUT1

Instance id: | SA2_XTD1_CRL/SWITCH/LENS9_OUT1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, CRLoutswitchesHaraldtest, SA2_MAIN_BKR-wallpaper, SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_OUT2

Instance id: | SA2_XTD1_CRL/SWITCH/LENS9_OUT2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_CRL/SWITCH_OUT_LENSES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### LENS10_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS10_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS10_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS10_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS1_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS1_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS1_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS2_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS2_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS2_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS3_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS3_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS3_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS4_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS4_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS4_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS5_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS5_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS5_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS6_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS7_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS8_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T1

Instance id: | SA2_XTD1_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LENS9_T2

Instance id: | SA2_XTD1_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### DAQ

[add component documentation]

##### MDL

[add component documentation]

###### DAQ_CONTROLLER

Instance id: | SA2_XTD1_DAQ/MDL/DAQ_CONTROLLER
Class id: | DaqController
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-11 , sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/daqController
Last modified: | 2021-05-10T09:05:08.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
Installed tag: | 1.4.4-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.4.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.4-2.10.0-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
- 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: |

#### DPS1

[add component documentation]

##### SWITCH

[add component documentation]

###### S20020A

Instance id: | SA2_XTD1_DPS1/SWITCH/S20020A
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### DPS2

[add component documentation]

##### SWITCH

[add component documentation]

###### S20070A

Instance id: | SA2_XTD1_DPS2/SWITCH/S20070A
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### EPS

[add component documentation]

##### MONITOR

[add component documentation]

###### C20109E

Instance id: | SA2_XTD1_EPS/MONITOR/C20109E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20307E

Instance id: | SA2_XTD1_EPS/MONITOR/C20307E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20404E

Instance id: | SA2_XTD1_EPS/MONITOR/C20404E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20504E

Instance id: | SA2_XTD1_EPS/MONITOR/C20504E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

#### FLT

[add component documentation]

##### DCTRL

[add component documentation]

###### MODE1

Instance id: | SA2_XTD1_FLT/DCTRL/MODE1
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | Filterbox_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### MODEM

Instance id: | SA2_XTD1_FLT/DCTRL/MODEM
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | Filterbox_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### MODES

Instance id: | SA2_XTD1_FLT/DCTRL/MODES
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, Filterbox_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

##### MDL

[add component documentation]

###### TARGET_POSITION

Instance id: | SA2_XTD1_FLT/MDL/TARGET_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD1_FLT, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### TARGET

##### SWITCH

[add component documentation]

###### S1

Instance id: | SA2_XTD1_FLT/SWITCH/S1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN, SA2_XTD1_FLT, SA2_MAIN_copy
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S2

Instance id: | SA2_XTD1_FLT/SWITCH/S2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN, SA2_XTD1_FLT, SA2_MAIN_copy
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S3

Instance id: | SA2_XTD1_FLT/SWITCH/S3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN_copy, SA2_XTD1_FLT, SA2_MAIN
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S4

Instance id: | SA2_XTD1_FLT/SWITCH/S4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN, SA2_XTD1_FLT, SA2_MAIN_copy
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S5

Instance id: | SA2_XTD1_FLT/SWITCH/S5
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN_copy, SA2_XTD1_FLT, SA2_MAIN
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S6

Instance id: | SA2_XTD1_FLT/SWITCH/S6
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN_copy, SA2_XTD1_FLT, SA2_MAIN
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S7

Instance id: | SA2_XTD1_FLT/SWITCH/S7
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_FLT, SA2_MAIN_copy, SA2_XTD1_FLT, SA2_MAIN
Scenes: | Filterbox_Overview_old0, SA2_XTD1_FLT/MOTOR/TARGET, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_FLT/MOTOR/TARGET, SA2_MAIN, Filterbox_Overview, Filterbox_Overview, SA2_MAIN, SA2_KMONO_MAIN, SA2_MAIN, Filterbox_Overview_old, SA2_MAIN, SA2_XTD1_FLT Switch Overview, SA2_MAIN_BKR-wallpaper, SA2_XTD1_FLT Switch Overview, Filterbox_Overview_old, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VDCTRL

[add component documentation]

###### MODE1

Instance id: | SA2_XTD1_FLT/VDCTRL/MODE1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Filterbox_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MODEM

Instance id: | SA2_XTD1_FLT/VDCTRL/MODEM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Filterbox_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### MODES

Instance id: | SA2_XTD1_FLT/VDCTRL/MODES
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Filterbox_Overview, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### IMGFEL

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy
Scenes: | SA2_IMGFEL_AVG, Beam_Imagers, SA2_IMGFEL_AVG, test/AVG, FEL_Averager_large, SA2_XTD1_IMGFEL_stripchart_for_tuning, SA2_XTD1_IMGFEL_stripchart_for_tuning, IMGFEL_AVG_VIEW, SA2_IMGFEL_MAIN_New, test/AVG, SA2_XGMvsFELIMG, MID_XTD6_IMGPI_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | exflcon72n0
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy, SA2_XTD1_IMGFEL, SA2_MAIN
Scenes: | FEL_Imager_large, SA2_XTD1_IMGFEL/CAM/BEAMVIEW, SA2_MAIN, SA2_IMGFEL_AVG, SA2_XTD1_IMGFEL/CAM/BEAMVIEW, Beam_Imagers, SA1_IMGFEL_MAIN, SA2_IMGFEL_AVG, SA2_MAIN, test/AVG, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN0, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN, SA2_MAIN, SA2_MAIN, SA2_IMGFEL_MAIN_New, test/AVG, SA2_MAIN_BKR-wallpaper, MID_XTD6_IMGPI_AVG, SA2_XTD1_IMGFEL/CAM/BEAMVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | SA2_XTD1_IMGFEL/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy, SA2_XTD1_IMGFEL, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | SA2_XTD1_IMGFEL/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy, SA2_XTD1_IMGFEL, SA2_MAIN
Scenes: | Beam_Imagers, SA1_IMGFEL_MAIN, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN0, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### FIXEDFILTER_POSITIONS

Instance id: | SA2_XTD1_IMGFEL/MDL/FIXEDFILTER_POSITIONS
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy
Scenes: | SA2_IMGFEL_MAIN0, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveND_0_3:
    Moves the motor to the position marked with this label
- moveND_0_6:
    Moves the motor to the position marked with this label
- moveND_0_9:
    Moves the motor to the position marked with this label
- moveND_2_0:
    Moves the motor to the position marked with this label
- moveND_3_0:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### SCREEN_POSITIONS

Instance id: | SA2_XTD1_IMGFEL/MDL/SCREEN_POSITIONS
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy
Scenes: | SA2_XTD1_IMGFEL/MDL/SCREEN_POSITIONS|scene, Beam_Imagers, SA2_XTD1_IMGFEL/MDL/SCREEN_POSITIONS|scene, SA2_XTD1_IMGFEL/MDL/SCREEN_POSITIONS|scene, SA2_IMGFEL_MAIN0, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN, SA2_IMGFEL_MAIN_New, SA2_MAIN_BKR-wallpaper, HED_BEAMLINE_STATUS/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveCBor:
    Moves the motor to the position marked with this label
- moveBN:
    Moves the motor to the position marked with this label
- moveYAG2:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### SCANTOOL

Instance id: | SA2_XTD1_IMGFEL/MDL/SCANTOOL
Class id: | Karabacon
Host: | sa2-br-sys-con-1
Class documentation:
| Karabacon
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Karabacon
Last modified: | 2021-10-04T15:54:23.336+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mamchykd, Hauf, Fabbri
Latest tag: | 2.4.6-2.11.1
Deployment tag: | 2.4.6-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- use_daq:
    If the scantool should be used without XFEL DAQ, set tofalse. Can only be set before instantiation.
- daqControllerId:
    The deviceId to the daq controller device.
- isConfigured:
    Boolean indicator if the scantool has been configured.
- actualConfiguration:
    String representation of the actual configuration applied for the scan
- activeSources:
    Alias representation of configured data sources
- activeMotors:
    Alias representation of configured motors
- activeTriggers:
    Alias representation of configured triggers
- dataEnv:
    Data Sources
- pipelineWait:
    Set this value to define the pipeline wait time for the data sources to wait for a new value
- pauseEachStep:
    Set to pause on arriving at each motor position
- reset:
    This value is used to reset the plotting
- stream:
    Internal value to signalize streaming while scanning
- isMoving:
    This boolean indicates if the karabacon is in moving state. Required for folding daq data.
- isAcquiring:
    This boolean indicates if the karabacon is acquiringdata. Required for folding daq data.
- acquisitionTime:
    The trigger sources will acquire each step for this period of time. In step scan operation, the Karabacon will wait each step to acquire for this period if configureTriggers is set to True. In continous mode, this value is used to calculate the velocity.
- configureTriggers:
    Set this value to True and the triggers will configure the acquisition time for each step
- configureVelocity:
    Set this value to True to control motor velocity during continuous motion scans. The speed will be calculated from ‘acquisitionTime’.
- availableScenes:
    Provides a scene for the Karabacon. This can be eithera control or plot related scene.
- availableMacros:
    Provides scan macros from the scan device
- output:
    Output Channel for the scan data
- configure:
    Configure the scan environment
- start:
    Start scan with previous applied configuration
- stop:
    Call this slot to stop running scan
- abort:
    Call this slot to stop everything
- pause:
    Call this slot to pause or resume running scan

Release History
2.4.6-2.11.1

Created: | 2021-08-25T16:30:39.000+02:00
Author: | Dennis Goeries
Notes: |

2.4.5-2.11.1

Created: | 2021-07-15T18:00:16.000+02:00
Author: | mamchykd
Notes: | Tag from master, DaqController dependency update

2.4.4-2.11.1

Created: | 2021-07-01T20:52:35.000+02:00
Author: | Steffen Hauf
Notes: | Add MC2 subclasses

2.4.3-2.11.1

Created: | 2021-06-29T00:23:24.000+02:00
Author: | mamchykd
Notes: | Transform functions for motor aNscans, dNscans, mesh and dmesh

2.4.2-2.11.1

Created: | 2021-06-08T17:52:45.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: simulatedTrigger tag updated

2.4.1-2.11.1

Created: | 2021-06-03T08:23:54.000+02:00
Author: | mamchykd
Notes: | Macro async

2.4.0-2.10.0

Created: | 2021-03-22T13:02:09.000+01:00
Author: | Wajid Ehsan
Notes: | Fixed Data source from the output channel value issue

2.3.9-2.10.0

Created: | 2021-02-23T10:06:06.000+01:00
Author: | Istvan Mohacsi
Notes: | Summary: Integrate automated alignment extension

2.3.8-2.10.0

Created: | 2021-01-27T19:43:42.000+01:00
Author: | Wajid Ehsan
Notes: | Include JJAttenuator device into scan tool

2.3.7-2.10.0

Created: | 2021-01-13T16:04:37.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.6-2.10.0

Created: | 2020-11-24T22:22:30.000+01:00
Author: | Wajid Ehsan
Notes: | update dependency file

2.3.5-2.10.0

Created: | 2020-11-23T13:18:15.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.5-2.9.1

Created: | 2020-10-16T13:50:26.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Update for new Beckhoff state diagram Installation: No changes. Devices: No change in devices. Schema: No change in schema.

2.3.4-2.9.1

Created: | 2020-09-28T12:18:29.000+02:00
Author: | Istvan Mohacsi
Notes: | Summary: Smaller fixes for misbehaving triggers, versioning, etc. Installation: No changes to dependencies, no special dependencies Devices: No change in devices. Schema: No change in schema.

2.3.3-2.9.0

Created: | 2020-06-04T17:04:30.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.2-2.8.0

Created: | 2020-05-14T13:24:49.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.8.0

Created: | 2020-04-17T14:19:55.000+02:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.7.2

Created: | 2020-03-03T13:10:32.000+01:00
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.8.0

Created: | 2020-03-03T13:00:40.000+01:00
Author: | Istvan Mohacsi
Notes: |

1.6.2-2.6.0

Created: | 2020-02-28T12:16:12.000+01:00
Author: | Wajid Ehsan
Notes: | add Johann Spectrometer class

##### MOTOR

[add component documentation]

###### FILTER

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGFEL/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon72n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy, SA2_XTD1_IMGFEL, SA2_MAIN
Scenes: | SA2_XTD1_UND/MDL/GAINCURVE_SCAN_scene, SA2_IMGFEL_AVG, SA1_IMGFEL_MAIN, SA2_IMGFEL_AVG, SA2_IMGFEL_MAIN, SA2_XGM_IMGFEL_Correlation_v3, SA2_XTD1_UND/MDL/GAINCURVE_SCAN_custom0, SA2_IMGFEL_MAIN0, Beam_POSITION, SA2_XTD1_IMGFEL_stripchart_for_tuning, SA2_XGM_IMGFEL_Correlation_v3, SA2_XTD1_IMGFEL_stripchart_for_tuning, SA2_IMGFEL_MAIN_New, test FELIMGvsXGM, SA2_XGMvsFELIMG, SA2_XTD1_UND-MDL-GAINCURVE_SCAN-scene, MID_XTD6_IMGPI_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### DECELERATE

Instance id: | SA2_XTD1_IMGFEL/SWITCH/DECELERATE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN, SA2_XTD1_IMGFEL, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SCREEN_OUT

Instance id: | SA2_XTD1_IMGFEL/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGFEL, SA2_MAIN_copy, SA2_XTD1_IMGFEL, SA2_MAIN
Scenes: | SA2_Watchdog_overview_screens, SA2_XTD1_IMGFEL/MOTOR/SCREEN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_MAIN, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_XTD1_IMGFEL/MOTOR/SCREEN, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_XTD1_IMGFEL/MOTOR/SCREEN, HED_BEAMLINE_STATUS/Shutdown, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | SA2_XTD1_IMGFEL/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### IMGSR

[add component documentation]

##### ACTRL

[add component documentation]

###### PD_BIAS

Instance id: | SA2_XTD1_IMGSR/ACTRL/PD_BIAS
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ADC

[add component documentation]

###### 1

Instance id: | SA2_XTD1_IMGSR/ADC/1
Class id: | FastAdc
Host: | sa2-xtd1-sys-utc-r21
Class documentation:
| FastAdc
Alias: | sa2-xtd1-sys-utc-r21-mch , sa2-xtd1-sys-utc-r21
Git repo: | https://git.xfel.eu/karaboDevices/fastAdc
Last modified: | 2021-10-05T11:19:39.976+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Hauf, Mamchykd, Fernands
Latest tag: | 2.8.6-2.11.1
Deployment tag: | 2.8.6-2.11.1
Installed tag: | 2.8.6-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_KMONO_CTRL, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA_XTD1_IMGSR/PINdiode_individual_peaks, test, SA2_KMONO-system, test
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Fast ADC

The `FastADC` device is documented in fastadc:welcome

Trouble Shooting

- If the device instantiate and goes immediately into error, even after server restarts,

> check the configuration of the Map directory parameter. For most crates it should be pointing to /home/xctrl/maps. If the problem persists, likely the driver was not loaded. If you have xctrl access to the crate, check if the Device file is present. If it is not or you do not have access, call EEE FPGA OCD.

- If you see flat noise in the raw data, stop the acquisition, click the ADC Reset button and start acquisition. If this doesn’t help, try restarting the device server (right click in the project, or topology view). If further help is needed, contact EEE FPGA OCD (9-8041).
- Make sure you have enablePeakComputation checked for those channels where you need it
- If you are outputting raw data and have incomplete data, or the device crashes recurrently, check the number of samples you are using. Known working sample numbers are ~800k samples on each channel.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- reset:
    Resets the device in case of an error
- trigger:
    Sends a software trigger to the hardware (always possible, independent of chosen trigger mode)
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- digitizerFrequency:
    ADC sampling frequency.
- adcRange:
    Voltage range (peak to peak) of ADC chips.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- rawFrequency:
    Raw data sampling frequency.
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.6-2.11.1

Created: | 2021-07-05T18:16:26.000+02:00
Author: | Wajid Ehsan
Notes: | Update tag for utca configuration

2.8.5-2.11.1

Created: | 2021-07-05T14:39:35.000+02:00
Author: | Wajid Ehsan
Notes: | Add Raw frequency parameter.

2.8.4-2.11.1

Created: | 2021-07-05T13:49:35.000+02:00
Author: | Wajid Ehsan
Notes: | update iibus tag (Fixed bug with 32 bit signed values_

2.8.3-2.11.1

Created: | 2021-06-25T13:42:45.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T19:42:44.000+02:00
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T18:00:03.000+02:00
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T16:21:15.000+02:00
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T11:37:55.000+02:00
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T18:15:10.000+02:00
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T09:25:59.000+02:00
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T14:52:10.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T12:52:36.000+01:00
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T14:31:13.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T17:43:01.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T16:25:10.000+02:00
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T10:12:17.000+02:00
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T19:36:37.000+02:00
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T13:38:00.000+01:00
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T13:27:17.000+01:00
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T09:56:32.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGSR/CAM/BEAMVIEW
Class id: | PhotonicScienceCamera
Host: | sa2-xtd1-sys-con-1
Class documentation:
| PhotonicScienceCamera
Alias: | sa2-xtd1-sys-con-1
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Installed tag: | 3.11.7-2.10.0
Projects: | SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_XTD1_IMGSR_IMAGE, SA2_XTD1_IMGSR_MAIN, SA2_MAIN, SA2_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_MAIN_BKR-wallpaper, SA2_XTD1_IMGSR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T11:38:08.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

##### DCTRL

[add component documentation]

###### AMP_GAIN_BIT0

Instance id: | SA2_XTD1_IMGSR/DCTRL/AMP_GAIN_BIT0
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AMP_GAIN_BIT1

Instance id: | SA2_XTD1_IMGSR/DCTRL/AMP_GAIN_BIT1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AMP_GAIN_BIT2

Instance id: | SA2_XTD1_IMGSR/DCTRL/AMP_GAIN_BIT2
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AMP_SPEED

Instance id: | SA2_XTD1_IMGSR/DCTRL/AMP_SPEED
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_POWER

Instance id: | SA2_XTD1_IMGSR/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR, SA2_XTD1_IMGSR, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | SA2_XTD1_IMGSR/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR, SA2_XTD1_IMGSR, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PD_POWER

Instance id: | SA2_XTD1_IMGSR/DCTRL/PD_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### LVDT

[add component documentation]

###### Y

Instance id: | SA2_XTD1_IMGSR/LVDT/Y
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_KMONO_MAIN, SA2_XTD1_IMGSR/MOTOR/Y
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### ADC_BUNCH

Instance id: | SA2_XTD1_IMGSR/MDL/ADC_BUNCH
Class id: | AdcBunchPattern
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/pulsePatternDecoder
Last modified: | 2021-09-10T16:40:35.942+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Haufs, Mercadier, Ehsan
Latest tag: | 2.0.5-2.11.0
Deployment tag: | 2.0.5-2.11.0
Installed tag: | 2.0.5-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- beamline:
    Which SASE is being scanned
- patternDecoder:
    PulsePattern Decoder deviceId
- adc:
    fastADC deviceId
- tuningDelay:
    Fixed value (number of samples), tuned by beamline scientist
- pulseInterval:
    Interval between two consecutive pulses
- pulseDelay:
    Number of samples between trigger and first pulse
- rawDelay:
    Time delay between trigger and start of raw data acquisition.
- pulsePeriod:
    Number of samples between pulses

Release History
2.0.5-2.11.0

Created: | 2021-07-23T15:24:27.000+02:00
Author: | Alessandro Silenzi
Notes: | no change in schema

2.0.4-2.10.4

Created: | 2021-05-17T19:36:32.000+02:00
Author: | Alessandro Silenzi
Notes: | Added Laser decoding to the PulsePatternDecoder

2.0.3-2.10.0

Created: | 2020-11-24T13:00:46.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.0.2-2.9.6-log-timestamps

Created: | 2020-09-24T14:48:03.000+02:00
Author: | Gabriele Giovanetti
Notes: |

2.0.2-2.9.6

Created: | 2020-09-16T15:50:05.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: prevent unwanted task in karabo 2.9 note: can be used also with other karabo versions

2.0.1-2.9.6

Created: | 2020-09-11T14:56:10.000+02:00
Author: | Gabriele Giovanetti
Notes: | Prevent timestamp jumping backwards

2.0.0-2.9.4-hotfix@SPB

Created: | 2020-09-11T14:11:25.000+02:00
Author: | Gabriele Giovanetti
Notes: | Temporary hotfix: bunchpattern table timestamp propagation leads to wrong data in DAQ

2.0.0-2.9.4

Created: | 2020-08-17T14:53:49.000+02:00
Author: | Steffen Hauf
Notes: | Read the patternTable via an input channel

1.5.0-2.7.0-hotfix

Created: | 2020-07-23T18:04:33.000+02:00
Author: | degon
Notes: | hotfix: fire start slot twice for digitizer

1.5.0-2.7.0

Created: | 2020-03-03T12:36:56.000+01:00
Author: | Wajid Ehsan
Notes: | Integration of new device class which facilitates the integration of Bunch pattern integration into Digitizer

1.4.1-2.6.1

Created: | 2019-11-12T14:57:06.000+01:00
Author: | Denys Mamchyk
Notes: | minor fix for updating the status on error

1.4.0-2.6.1

Created: | 2019-10-04T14:14:33.000+00:00
Author: | Valerii Bondar
Notes: | “Proper” deployment tag from ‘master’ branch. Includes OperationChangeNotifier with no prints.

1.4.0-2.6.1-test

Created: | 2019-10-02T18:48:32.000+02:00
Author: | Valerii Bondar
Notes: | Left by Valerii in his rush to the airport, but we need it now. Print statement must be removed

1.3.2-2.5.0-Notifier

Created: | 2019-09-23T13:53:03.000+02:00
Author: | Valerii Bondar
Notes: | This tag is only for tests of OperationChangeNotifier prototype in MID topic. For production deployment use ‘proper’ tag recommended. This tag should be installed only afterwards (with install_device_active.yml) and decommissioned after tests.

1.3.2-2.5.0

Created: | 2019-08-07T17:00:04.000+02:00
Author: | Denys Mamchyk
Notes: | update for rawDelay calculation

1.3.1-2.5.0

Created: | 2019-08-02T17:21:20.000+02:00
Author: | Wajid Ehsan
Notes: | Set pulse Delay

1.3.0-2.5.0

Created: | 2019-07-30T13:43:21.000+02:00
Author: | Cammille Carinan
Notes: | Integration of bunch pattern setting into fastadc device.

1.2.0-2.3.0

Created: | 2019-03-13T19:08:04.000+01:00
Author: | Alessandro Silenzi
Notes: | Using the euxfel_bunch_pattern package

1.1.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | added MainDump node

1.0.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | Main dump is included in the decoding

###### SCREEN_POSITION

Instance id: | SA2_XTD1_IMGSR/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_XTD1_IMGSR/MDL/SCREEN_POSITION|scene, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR/MDL/SCREEN_POSITION|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveretracted:
    Moves the motor to the position marked with this label
- moveYAG1:
    Moves the motor to the position marked with this label
- moveGOS:
    Moves the motor to the position marked with this label
- moveempty:
    Moves the motor to the position marked with this label
- movephotodiode:
    Moves the motor to the position marked with this label
- moveparking:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### FOCUS

###### IRIS

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_IMGSR/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon206
Class documentation:
| ImageProcessor
Alias: | sa2-xtd1-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | SA2_XTD1_IMGSR, SA2_MAIN, SA2_XTD1_IMGSR, SA2_MAIN_copy
Scenes: | SA2_KMONO_CTRL, SA2_XTD1_IMGSR, SA2_XTD1_IMGSR, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_XTD1_IMGSR
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### AMP_OVERLOAD

Instance id: | SA2_XTD1_IMGSR/SWITCH/AMP_OVERLOAD
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Scenes: | SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/PINdiode, SA2_XTD1_IMGSR/ADC/1, SA2_XTD1_IMGSR/ADC/1, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DECELERATE

Instance id: | SA2_XTD1_IMGSR/SWITCH/DECELERATE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_IMGSR, SA2_MAIN_copy, SA2_XTD1_IMGSR, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | SA2_XTD1_IMGSR/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### KMONO

[add component documentation]

##### ACTRL

[add component documentation]

###### SPARE_2

Instance id: | SA2_XTD1_KMONO/ACTRL/SPARE_2
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### LVDT

[add component documentation]

###### X

Instance id: | SA2_XTD1_KMONO/LVDT/X
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN_copy, SA2_XTD1_KMONO, SA2_MAIN
Scenes: | SA2_XTD1_KMONO/MOTOR/X, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/X, SA2_XTD1_KMONO/MOTOR/X, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO-test, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### Y1

Instance id: | SA2_XTD1_KMONO/LVDT/Y1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN_copy, SA2_XTD1_KMONO, SA2_MAIN
Scenes: | SA2_XTD1_KMONO/MOTOR/Y1, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/Y1, SA2_XTD1_KMONO/MOTOR/Y1, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/Y1|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### Y2

Instance id: | SA2_XTD1_KMONO/LVDT/Y2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN, SA2_XTD1_KMONO, SA2_MAIN_copy
Scenes: | SA2_XTD1_KMONO/MOTOR/Y2, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/Y2, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/Y2, SA2_XTD1_KMONO/MOTOR/Y1|motorScene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### THETA1

###### THETA2

###### Y1

###### Y2

##### SWITCH

[add component documentation]

###### X

Instance id: | SA2_XTD1_KMONO/SWITCH/X
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN_copy, SA2_XTD1_KMONO, SA2_MAIN
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_XTD1_KMONO/MOTOR/X, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO/MOTOR/X, SA2_MAIN, SA2_XTD1_KMONO/MOTOR/X, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_XTD1_KMONO-test, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_XTD1_KMONO-test, SA2_KMONO_MAIN, SA2_MAIN, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_MAIN, SA2_MAIN_BKR-wallpaper, test, SA2_KMONO-system, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### X_EPS

Instance id: | SA2_XTD1_KMONO/SWITCH/X_EPS
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_KMONO_MAIN, SA2_MAIN_BKR-wallpaper, test, SA2_KMONO-system, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### X_NO

Instance id: | SA2_XTD1_KMONO/SWITCH/X_NO
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN, SA2_XTD1_KMONO, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### CRYSTAL1

Instance id: | SA2_XTD1_KMONO/TSENS/CRYSTAL1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN, SA2_XTD1_KMONO, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL2

Instance id: | SA2_XTD1_KMONO/TSENS/CRYSTAL2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN_copy, SA2_XTD1_KMONO, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### THETA1

Instance id: | SA2_XTD1_KMONO/TSENS/THETA1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN, SA2_XTD1_KMONO, SA2_MAIN_copy
Scenes: | SA2_KMONO_CTRL, SA2_XTD1_KMONO-test, SA2_XTD1_KMONO-test2, SA2_XTD1_KMONO-test2, SA2_XTD1_KMONO-test2, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### THETA2

Instance id: | SA2_XTD1_KMONO/TSENS/THETA2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_KMONO, SA2_MAIN, SA2_XTD1_KMONO, SA2_MAIN_copy
Scenes: | SA2_KMONO_CTRL, SA2_XTD1_KMONO-test3, SA2_XTD1_KMONO-test3, SA2_XTD1_KMONO-test3, test, SA2_KMONO-system
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### MOV

[add component documentation]

##### MONITOR

[add component documentation]

###### C20106M

Instance id: | SA2_XTD1_MOV/MONITOR/C20106M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20107M

Instance id: | SA2_XTD1_MOV/MONITOR/C20107M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20108M

Instance id: | SA2_XTD1_MOV/MONITOR/C20108M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20304M

Instance id: | SA2_XTD1_MOV/MONITOR/C20304M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20403M

Instance id: | SA2_XTD1_MOV/MONITOR/C20403M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

#### PSLIT

[add component documentation]

##### LVDT

[add component documentation]

###### BLADE_BOTTOM

Instance id: | SA2_XTD1_PSLIT/LVDT/BLADE_BOTTOM
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SA2_XTD1_PSLIT_MOTOR_BLADE_BOTTOM, SA2_XTD1_PSLIT_MOTOR_BLADE_BOTTOM_SETUP, SASE2_SRA, SA2_XTD1_PSLIT_MOTOR_BLADE_BOTTOM_SETUP, SA2_Motor_Positions_Overview, SASE2_SRA, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT

Instance id: | SA2_XTD1_PSLIT/LVDT/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SA2_XTD1_PSLIT_MOTOR_BLADE_LEFT, SA2_XTD1_PSLIT_MOTOR_BLADE_LEFT_SETUP, SASE2_SRA, SA2_XTD1_PSLIT_MOTOR_BLADE_LEFT_SETUP, SA2_Motor_Positions_Overview, SASE2_SRA, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT

Instance id: | SA2_XTD1_PSLIT/LVDT/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SA2_XTD1_PSLIT_MOTOR_BLADE_RIGHT_SETUP, SASE2_SRA, SA2_Motor_Positions_Overview, SASE2_SRA, SA2_XTD1_PSLIT_MOTOR_BLADE_RIGHT, SA2_XTD1_PSLIT_MOTOR_BLADE_RIGHT_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP

Instance id: | SA2_XTD1_PSLIT/LVDT/BLADE_TOP
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SA2_XTD1_PSLIT_MOTOR_BLADE_TOP_SETUP, SA2_XTD1_PSLIT_MOTOR_BLADE_TOP, SA2_XTD1_PSLIT_MOTOR_BLADE_TOP_SETUP, SASE2_SRA, SA2_Motor_Positions_Overview, SASE2_SRA, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

###### BLADE_TOP

##### SWITCH

[add component documentation]

###### WATER

Instance id: | SA2_XTD1_PSLIT/SWITCH/WATER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### BLADE_BOTTOM_B4C

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_BOTTOM_B4C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_BOTTOM_W

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_BOTTOM_W
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_B4C

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_LEFT_B4C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_LEFT_W

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_LEFT_W
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_B4C

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_RIGHT_B4C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT_W

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_RIGHT_W
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_B4C

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_TOP_B4C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_TOP_W

Instance id: | SA2_XTD1_PSLIT/TSENS/BLADE_TOP_W
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_SRA, SA2_MAIN_copy
Scenes: | SASE2_SRA, SASE2_SRA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### SHUT

[add component documentation]

##### DCTRL

[add component documentation]

###### ACLOSE

Instance id: | SA2_XTD1_SHUT/DCTRL/ACLOSE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | SA2_XTD1_SHUT/DCTRL/AOPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### ACLOSE

Instance id: | SA2_XTD1_SHUT/SWITCH/ACLOSE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, SA2_EPS2MPS, MPS_TEST, SA2_EPS2MPS, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, VAC_TO_MPS_USER_OLD, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, SA2_SYS_EPS2MPS_DCTRL_SHUT_XS2_ACLOSE_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_SHUT_XS2_ACLOSE_INTERLOCK, VAC_TO_MPS_USER_OLD, SA2_EPS2MPS, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | SA2_XTD1_SHUT/SWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VAC_TO_MPS_USER, VS20060_VS20070, SA2_EPS2MPS, SA2_MAIN, SA2_MAIN, MPS_TEST, VS20060_VS20070_OLD, SA2_EPS2MPS, VS20060_VS20070, VAC_TO_MPS_USER_OLD, SA2_MAIN, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VS20060_VS20070, SA2_MAIN, VAC_TO_MPS_USER_OLD, SA2_EPS2MPS, SA2_MAIN, VAC_TO_MPS, SA2_MAIN, VS20060_VS20070_OLD, VAC_TO_MPS_USER, VS20060_VS20070, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VS20060_VS20070_OLD, VAC_TO_MPS_USER, BiancaTest2, VS20060_VS20070, VS20060_VS20070, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WATER

Instance id: | SA2_XTD1_SHUT/SWITCH/WATER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ACLOSE_IN_EPS

Instance id: | SA2_XTD1_SHUT/SWITCH/ACLOSE_IN_EPS
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN_IN_EPS

Instance id: | SA2_XTD1_SHUT/SWITCH/AOPEN_IN_EPS
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD1_SHUT/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD1_SHUT/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T3

Instance id: | SA2_XTD1_SHUT/TSENS/T3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T4

Instance id: | SA2_XTD1_SHUT/TSENS/T4
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VSWITCH

[add component documentation]

###### ACLOSE

Instance id: | SA2_XTD1_SHUT/VSWITCH/ACLOSE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AOPEN

Instance id: | SA2_XTD1_SHUT/VSWITCH/AOPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### SYS

[add component documentation]

##### SWITCH

[add component documentation]

###### BKF10011_G1_OK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10011_G1_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10011_G2_OK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10011_G2_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10011_G3_OK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10011_G3_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10011_G4_BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10011_G4_BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10011_G4_REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10011_G4_REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10012_G2_OK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10012_G2_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10012_G3_OK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10012_G3_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10012_G4_BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10012_G4_BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10012_G4_REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/BKF10012_G4_REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20104V_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20104V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20104V_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20104V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20104V_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20104V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20104V_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20104V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20106M_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20106M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20106M_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20106M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20106M_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20106M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20106M_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20106M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK201, RACK201, RACK201, RACK201
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20107M_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20107M_T1OK
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | RACK201, RACK201, RACK201
Accessible by: | CONTROLS, DA

[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: |

###### C20107M_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20107M_T2OK
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | RACK201, RACK201, RACK201
Accessible by: | CONTROLS, DA

[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: |

###### C20107M_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20107M_T3BALOK
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | RACK201, RACK201, RACK201
Accessible by: | CONTROLS, DA

[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: |

###### C20107M_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20107M_T3REDOK
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | RACK201, RACK201, RACK201
Accessible by: | CONTROLS, DA

[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: |

###### C20109E_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20109E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20109E_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20109E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20109E_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20109E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20109E_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20109E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20201V_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20201V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20201V_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20201V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20201V_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20201V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20201V_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20201V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20203E_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20203E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20203E_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20203E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20203E_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20203E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20203E_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20203E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK202, RACK202
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20303V_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20303V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20303V_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20303V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20303V_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20303V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20303V_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20303V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20304M_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20304M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20304M_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20304M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20304M_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20304M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20304M_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20304M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20307E_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20307E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20307E_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20307E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20307E_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20307E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20307E_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20307E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK203
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20402V_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20402V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20402V_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20402V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20402V_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20402V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20402V_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20402V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20403M_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20403M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20403M_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20403M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20403M_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20403M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20403M_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20403M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20404E_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20404E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20404E_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20404E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20404E_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20404E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20404E_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20404E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK204
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20502V_T1OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20502V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK205
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20502V_T2OK

Instance id: | SA2_XTD1_SYS/SWITCH/C20502V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK205
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20502V_T3BALOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20502V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK205
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20502V_T3REDOK

Instance id: | SA2_XTD1_SYS/SWITCH/C20502V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK205
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20010W

Instance id: | SA2_XTD1_SYS/SWITCH/S20010W
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20060W

Instance id: | SA2_XTD1_SYS/SWITCH/S20060W
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S22060W

Instance id: | SA2_XTD1_SYS/SWITCH/S22060W
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### S20030T

Instance id: | SA2_XTD1_SYS/TSENS/S20030T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20040T

Instance id: | SA2_XTD1_SYS/TSENS/S20040T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20050T

Instance id: | SA2_XTD1_SYS/TSENS/S20050T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20080T

Instance id: | SA2_XTD1_SYS/TSENS/S20080T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20090T

Instance id: | SA2_XTD1_SYS/TSENS/S20090T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S20100T

Instance id: | SA2_XTD1_SYS/TSENS/S20100T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S22080T

Instance id: | SA2_XTD1_SYS/TSENS/S22080T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S22090T

Instance id: | SA2_XTD1_SYS/TSENS/S22090T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S22100T

Instance id: | SA2_XTD1_SYS/TSENS/S22100T
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### UTC-R21-S4

Instance id: | SA2_XTD1_SYS/TSYS/UTC-R21-S4
Class id: | X2Timer
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.8-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN, SA2_DOOCS, SA2_DOOCS_copy, SA2_DOOCS, SA2_MAIN_copy
Scenes: | HED_XTD6_PPU/PulseOnDemandExpert, HED_XTD6_PPU/SimpleView, HED_XTD6_PPU/SimpleViewNewMDL
Accessible by: | CAL, 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.16-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- bunchPatternDelay:
    Delay of the bunch pattern as a whole. Only triggers using the bunch pattern will be affected.
- updateInterval:
    The interval for updating the x2Timer for read-out values.

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T08:05:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

#### UND

[add component documentation]

##### DOOCS

[add component documentation]

###### 2200

###### 2206

###### 2212

###### 2218

###### 2224

###### 2230

###### 2237

###### 2243

###### 2249

###### 2255

###### 2261

###### 2267

###### 2273

###### 2279

###### 2285

###### 2291

###### 2297

###### 2304

###### 2310

###### 2316

###### 2322

###### 2328

###### 2334

###### 2340

###### 2346

###### 2352

###### 2358

###### 2365

###### 2371

###### 2377

###### 2383

###### 2389

###### 2395

###### 2401

###### 2407

###### 2413

###### 2419

###### SA2_UNDGROUP

###### UNDULATOR_CELLS

###### UNDULATOR_CELLS_PS

##### MDL

[add component documentation]

###### GAINCURVE_SCAN

#### VAC

[add component documentation]

##### ASENS

[add component documentation]

###### C20308G_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20308G_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20308G_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20308G_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20308G_LOG_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20308G_LOG_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20308G_LOG_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20308G_LOG_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_B1

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_B1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_C2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_C2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_COMB2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_COMB2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_LOG_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_LOG_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_LOG_B1

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_LOG_B1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_LOG_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_LOG_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_LOG_C2

Instance id: | SA2_XTD1_VAC/ASENS/C20503G_LOG_C2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_B1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_C2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_C2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_COMB2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_COMB2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_LOG_A2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_LOG_A2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_LOG_B1

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_LOG_B1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_LOG_B2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_LOG_B2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_LOG_C2

Instance id: | SA2_XTD1_VAC/ASENS/C20405G_LOG_C2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### DCTRL

[add component documentation]

###### C20503G_B1

Instance id: | SA2_XTD1_VAC/DCTRL/C20503G_B1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_C2

Instance id: | SA2_XTD1_VAC/DCTRL/C20503G_C2
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DP_XGM_DP_OK

Instance id: | SA2_XTD1_VAC/DCTRL/DP_XGM_DP_OK
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20020G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20030G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20190G_INTERLOCK, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, VS20040_VS20050, SA2_OVERVIEW_VACUUM, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_VALVE_V20200G_INTERLOCK, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20010_VS20020, VS20040_VS20050, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, VS20010_VS20020_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TURBO_FAILURE, VS20010_VS20020, VS20010_VS20020, VS20040_VS20050, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20010C_HV_OFF

Instance id: | SA2_XTD1_VAC/DCTRL/G20010C_HV_OFF
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20020C_HV_OFF

Instance id: | SA2_XTD1_VAC/DCTRL/G20020C_HV_OFF
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20030C_HV_OFF

Instance id: | SA2_XTD1_VAC/DCTRL/G20030C_HV_OFF
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20040C_HV_OFF

Instance id: | SA2_XTD1_VAC/DCTRL/G20040C_HV_OFF
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20141P_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20141P_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20142C_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20143P_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20143P_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20144C_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20148P_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20148P_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20149C_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OK_TO_XGM

Instance id: | SA2_XTD1_VAC/DCTRL/OK_TO_XGM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PB_STOPPER_CLOSED_2DESY

Instance id: | SA2_XTD1_VAC/DCTRL/PB_STOPPER_CLOSED_2DESY
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN
Scenes: | MVS_TEST, MVS_TEST, MVS_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PNACT_V20000M_CLOSE

Instance id: | SA2_XTD1_VAC/DCTRL/PNACT_V20000M_CLOSE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PNACT_V20000M_OPEN

Instance id: | SA2_XTD1_VAC/DCTRL/PNACT_V20000M_OPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_CLOSE

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_CLOSE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_CTRL2_RESET

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_CTRL2_RESET
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_CTRL_RESET

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_CTRL_RESET
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_IS_OPEN_2DESY

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_IS_OPEN_2DESY
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_IS_READY_2DESY

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_IS_READY_2DESY
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_OPEN

Instance id: | SA2_XTD1_VAC/DCTRL/V20010F_OPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20010

Instance id: | SA2_XTD1_VAC/DCTRL/VS20010
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VS20010_VS20020, SA2_XTD1_VAC_PNACT_V20000M_INTERLOCK, SA2_XTD1_VAC_VALVE_V20020G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20030G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, MVS_TEST, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, MVS_TEST, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, MVS_TEST, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20010_P_OK_2DESY

Instance id: | SA2_XTD1_VAC/DCTRL/VS20010_P_OK_2DESY
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN
Scenes: | MVS_TEST, MVS_TEST, MVS_TEST
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20020

Instance id: | SA2_XTD1_VAC/DCTRL/VS20020
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VS20010_VS20020, SA2_XTD1_VAC_PNACT_V20000M_INTERLOCK, SA2_XTD1_VAC_VALVE_V20020G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20030G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20190G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20040

Instance id: | SA2_XTD1_VAC/DCTRL/VS20040
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20030G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20190G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20210G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_VALVE_V20200G_INTERLOCK, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM, VS20040_VS20050, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20050

Instance id: | SA2_XTD1_VAC/DCTRL/VS20050
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20190G_INTERLOCK, SA2_XTD1_VAC_VALVE_V20210G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_VALVE_V20200G_INTERLOCK, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070, SA2_XTD1_VAC_VALVE_V20220G_INTERLOCK, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20060_VS20070, VS20060_VS20070, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20060

Instance id: | SA2_XTD1_VAC/DCTRL/VS20060
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20210G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, SA2_XTD6_VAC_VALVE_V20230G_INTERLOCK, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_VALVE_V20200G_INTERLOCK, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070, SA2_XTD1_VAC_VALVE_V20220G_INTERLOCK, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20060_VS20070, VS20060_VS20070, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VS20070

Instance id: | SA2_XTD1_VAC/DCTRL/VS20070
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20210G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070_OLD, VS20080_VS20090_VS20100_OLD, SA2_OVERVIEW_VACUUM, SA2_XTD6_VAC_VALVE_V20230G_INTERLOCK, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20080_VS20090_VS20100_OLD, SA2_XTD6_VAC_VALVE_V20240G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070, VS20080_VS20090_VS20100, SA2_XTD1_VAC_VALVE_V20220G_INTERLOCK, VS20080_VS20090_VS20100, VS20080_VS20090_VS20100, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20120_VS20130_VS20140, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20080_VS20090_VS20100, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20080_VS20090_VS20100, VS20060_VS20070_OLD, VS20080_VS20090_VS20100_OLD, SA2_OVERVIEW_VACUUM, VS20060_VS20070, VS20060_VS20070, VS20080_VS20090_VS20100, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XTD1_VALVES_OPEN

Instance id: | SA2_XTD1_VAC/DCTRL/XTD1_VALVES_OPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, MPS_TEST, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER_OLD, VAC_TO_MPS, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, BiancaTest2, VAC_TO_MPS_USER_OLD, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1

Instance id: | SA2_XTD1_VAC/DCTRL/C20405G_B1
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_C2

Instance id: | SA2_XTD1_VAC/DCTRL/C20405G_C2
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20146P_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20146P_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_POWER

Instance id: | SA2_XTD1_VAC/DCTRL/G20147C_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### GAUGE

[add component documentation]

###### CRL_COMB

Instance id: | SA2_XTD1_VAC/GAUGE/CRL_COMB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20050_CRL_MKS_GAUGES_OLD, VS20040_VS20050_OLD, VS20050_CRL_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20010C

Instance id: | SA2_XTD1_VAC/GAUGE/G20010C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, V20010F_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, V20010F, VS20010_VS20020_OLD, VS20010_VS20020, V20010F_MDL, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20020C

Instance id: | SA2_XTD1_VAC/GAUGE/G20020C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, V20010F_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, V20010F, VS20010_VS20020_OLD, VS20010_VS20020, V20010F_MDL, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20030C

Instance id: | SA2_XTD1_VAC/GAUGE/G20030C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, V20010F_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, V20010F, VS20010_VS20020_OLD, VS20010_VS20020, V20010F_MDL, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20040C

Instance id: | SA2_XTD1_VAC/GAUGE/G20040C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, V20010F_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, V20010F, VS20010_VS20020_OLD, VS20010_VS20020, V20010F_MDL, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20050C

Instance id: | SA2_XTD1_VAC/GAUGE/G20050C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, Graph, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20060P

Instance id: | SA2_XTD1_VAC/GAUGE/G20060P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, BACKING_PRESSURE_XTD1, BACKING_PUMP_STATUS_OLD, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, BACKING-PUMP-STATUS_OLD, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, G20060P, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, BACKING-PUMP-STATUS_OLD, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, XTD1, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, BACKING-PUMP-STATUS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20060P_SETPOINT_1

Instance id: | SA2_XTD1_VAC/GAUGE/G20060P_SETPOINT_1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20060P_SETPOINT_2

Instance id: | SA2_XTD1_VAC/GAUGE/G20060P_SETPOINT_2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20070P

Instance id: | SA2_XTD1_VAC/GAUGE/G20070P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20080C

Instance id: | SA2_XTD1_VAC/GAUGE/G20080C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, Graph, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20110C

Instance id: | SA2_XTD1_VAC/GAUGE/G20110C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, Graph, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20120P

Instance id: | SA2_XTD1_VAC/GAUGE/G20120P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20130P

Instance id: | SA2_XTD1_VAC/GAUGE/G20130P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, BACKING_PRESSURE_XTD1, BACKING_PUMP_STATUS_OLD, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, BACKING-PUMP-STATUS_OLD, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, G20130P, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, BACKING-PUMP-STATUS_OLD, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, XTD1, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, BACKING-PUMP-STATUS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20130P_SETPOINT_1

Instance id: | SA2_XTD1_VAC/GAUGE/G20130P_SETPOINT_1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20130P_SETPOINT_2

Instance id: | SA2_XTD1_VAC/GAUGE/G20130P_SETPOINT_2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20140C

Instance id: | SA2_XTD1_VAC/GAUGE/G20140C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, Graph, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20141P

Instance id: | SA2_XTD1_VAC/GAUGE/G20141P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20141P_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20141P_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C

Instance id: | SA2_XTD1_VAC/GAUGE/G20142C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20142C_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20143P

Instance id: | SA2_XTD1_VAC/GAUGE/G20143P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20050_CRL_MKS_GAUGES_OLD, VS20040_VS20050_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20143P_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20143P_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C

Instance id: | SA2_XTD1_VAC/GAUGE/G20144C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20050_CRL_MKS_GAUGES_OLD, VS20040_VS20050_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20144C_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20148P

Instance id: | SA2_XTD1_VAC/GAUGE/G20148P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20148P_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20148P_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C

Instance id: | SA2_XTD1_VAC/GAUGE/G20149C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20149C_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SOL_ATT_COMB

Instance id: | SA2_XTD1_VAC/GAUGE/SOL_ATT_COMB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### XS2_SHUT_COMB

Instance id: | SA2_XTD1_VAC/GAUGE/XS2_SHUT_COMB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20146P

Instance id: | SA2_XTD1_VAC/GAUGE/G20146P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20146P_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20146P_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C

Instance id: | SA2_XTD1_VAC/GAUGE/G20147C
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_BUFF

Instance id: | SA2_XTD1_VAC/GAUGE/G20147C_BUFF
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PREABS_COMB

Instance id: | SA2_XTD1_VAC/GAUGE/PREABS_COMB
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### GCTRL

[add component documentation]

###### C20204G_G20050C

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20050C
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20204G_G20070P

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20070P
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20204G_G20080C

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20080C
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20204G_G20110C

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20110C
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20204G_G20120P

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20120P
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20204G_G20140C

Instance id: | SA2_XTD1_VAC/GCTRL/C20204G_G20140C
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | XGS600-XTD01_DPS-Setpoint_Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ICTRL

[add component documentation]

###### C20101I

Instance id: | SA2_XTD1_VAC/ICTRL/C20101I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RACK_MONITOR, RACK201, RACK201, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, RACK201, RACK201, SA2_RACK_MONITOR, SA2_RACK_MONITOR, C20101I, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20102I

Instance id: | SA2_XTD1_VAC/ICTRL/C20102I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RACK_MONITOR, RACK201, RACK201, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, RACK201, RACK201, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20301I

Instance id: | SA2_XTD1_VAC/ICTRL/C20301I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, RACK203, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20302I

Instance id: | SA2_XTD1_VAC/ICTRL/C20302I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, RACK203, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20401I

Instance id: | SA2_XTD1_VAC/ICTRL/C20401I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK204, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20501I

Instance id: | SA2_XTD1_VAC/ICTRL/C20501I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, RACK205, SA2_RACK_MONITOR
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### IPUMP

[add component documentation]

###### P20010I

Instance id: | SA2_XTD1_VAC/IPUMP/P20010I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_IONPUMPS_PRESSURE, VS20010_VS20020_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, P20010I, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_pressure, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20020I

Instance id: | SA2_XTD1_VAC/IPUMP/P20020I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_IONPUMPS_PRESSURE, VS20010_VS20020_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_pressure, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20030I

Instance id: | SA2_XTD1_VAC/IPUMP/P20030I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_IONPUMPS_PRESSURE, VS20010_VS20020_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_pressure, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20040I

Instance id: | SA2_XTD1_VAC/IPUMP/P20040I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_IONPUMPS_PRESSURE, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20020_pressure, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20140I

Instance id: | SA2_XTD1_VAC/IPUMP/P20140I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_pressure, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20150I

Instance id: | SA2_XTD1_VAC/IPUMP/P20150I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_pressure, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20160I

Instance id: | SA2_XTD1_VAC/IPUMP/P20160I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_pressure, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20170I

Instance id: | SA2_XTD1_VAC/IPUMP/P20170I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_pressure, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20180I

Instance id: | SA2_XTD1_VAC/IPUMP/P20180I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_pressure, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20190I

Instance id: | SA2_XTD1_VAC/IPUMP/P20190I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20040_VS20050, VS20040_VS20050, VS20040_VS20050, SA2_IONPUMPS_PRESSURE, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050_OLD, VS20040_VS20050, VS20040_VS20050, VS20050_CRL_MKS_GAUGES_OLD, VS20040_VS20050_OLD, VS20050_pressure, VS20050_CRL_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20200I

Instance id: | SA2_XTD1_VAC/IPUMP/P20200I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_pressure, VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20210I

Instance id: | SA2_XTD1_VAC/IPUMP/P20210I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_pressure, VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20220I

Instance id: | SA2_XTD1_VAC/IPUMP/P20220I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_pressure, VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20230I

Instance id: | SA2_XTD1_VAC/IPUMP/P20230I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, test-voltage, VS20060_VS20070_OLD, VS20060_pressure, VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20240I

Instance id: | SA2_XTD1_VAC/IPUMP/P20240I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, VS20060_VS20070_OLD, VS20070_pressure, VS20070_XS2_SHUT_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20250I

Instance id: | SA2_XTD1_VAC/IPUMP/P20250I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN_copy, SA2_ION_PUMPS, SA2_VACUUM, SA2_MAIN
Scenes: | VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, SA2_IONPUMPS_PRESSURE, VS20060_VS20070, VS20060_VS20070_OLD, VS20060_VS20070, VS20060_VS20070, VS20060_VS20070_OLD, VS20070_pressure, VS20070_XS2_SHUT_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20215I

Instance id: | SA2_XTD1_VAC/IPUMP/P20215I
Class id: | BeckhoffAgilentIonPump
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_pressure, VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- onSetpoint:
    Boolean indicating if the pump has reached the setpoint.
- isSwitchedOn:
    Boolean indicating if the high voltage was switched ON/OFF (valueBit 12) with the slot calls hvOn and hvOff.
- slimInterface:
    True: Slim interface with setpoint DI only. False: Full interface as in IO struct.
- pressure:
    Pressure read out from analog input. NOT available in slim mode.
- voltage:
    Voltage read out from analog input. NOT available in slim mode.
- hvOn:
    Turn the pump module ON. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- hvOff:
    Turn the pump module OFF. This is done either via serial command or digital output depending on the firmware configuration. No channel selection required as configured in the firmware.
- channelSelection:
    Channel on the controller for the pump.
- highVoltageOn:
    Turn on high voltage of the selected channel; this is a serial Property
- pressureSerial:
    Presssure of the selected channel; this is a serial readout.
- deviceInSlot:
    Device in the selected channel; this is a serial Property
- maximumPower:
    Maximum power for the selected channel; this is a serial Property
- targetVoltage:
    Target Voltage for the selected channel; this is a serial Property
- protectCurrent:
    Protect current for the selected channel; this is a serial Property
- setPoint:
    Setpoint for the selected channel; this is a serial Property
- temperatureHV:
    Temperature for HV end for the selected channel; this is a serial Property
- voltageSerial:
    Voltage for the selected channel; this is a serial Property
- highVoltageOn1:
    Turn on high voltage of channel 1.
- highVoltageOn2:
    Turn on high voltage of channel 2.
- highVoltageOn3:
    Turn on high voltage of channel 3.
- highVoltageOn4:
    Turn on high voltage of channel 4.
- pressureCh1:
    Pressure for channel 1. This is a serial readout.
- pressureCh2:
    Pressure for channel 2. This is a serial readout.
- pressureCh3:
    Pressure for channel 3. This is a serial readout.
- pressureCh4:
    Pressure for channel 4. This is a serial readout.
- deviceInSlot1:
    Device in slot 1.
- deviceInSlot2:
    Device in slot 2.
- deviceInSlot3:
    Device in slot 3.
- deviceInSlot4:
    Device in slot 4.
- maximumPower1:
    Maximum power for channel 1
- maximumPower2:
    Maximum power for Channel 2
- maximumPower3:
    Maximum power for Channel 3
- maximumPower4:
    Maximum power for Channel 4
- targetVoltage1:
    Target Voltage Channel 1
- targetVoltage2:
    Target voltage for channel 2
- targetVoltage3:
    Target voltage for channel 3
- targetVoltage4:
    Target voltage for channel 4.
- protectCurrent1:
    Protect current for channel 1.
- protectCurrent2:
    Protect current for channel 2.
- protectCurrent3:
    Protect current for channel 3.
- protectCurrent4:
    Protect current for channel 4.
- setPoint1:
    Setpoint for channel 1.
- setPoint2:
    Setpoint for channel 2.
- setPoint3:
    Set Point for channel 3.
- setPoint4:
    Setpoint for channel 4.
- temperatureHV1:
    Temperature HV for channel 1.
- temperatureHV2:
    Temperature HV for channel 2.
- temperatureHV3:
    Temperature HV for channel 3.
- temperatureHV4:
    Temperature HV for channel 4.
- voltageCh1:
    Voltage for channel 1.
- voltageCh2:
    Voltage for channel 2.
- voltageCh3:
    Voltage for channel 3.
- voltageCh4:
    Voltage for channel 4.
- currentSerial:
    Current for the selected channel.
- currentCh1:
    Current for channel 1.
- currentCh2:
    Current for channel 2.
- currentCh3:
    Current for channel 3.
- currentCh4:
    Current for channel 4.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MONITOR

[add component documentation]

###### C20104V

Instance id: | SA2_XTD1_VAC/MONITOR/C20104V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20201V

Instance id: | SA2_XTD1_VAC/MONITOR/C20201V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20202V

Instance id: | SA2_XTD1_VAC/MONITOR/C20202V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20203E

Instance id: | SA2_XTD1_VAC/MONITOR/C20203E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20303V

Instance id: | SA2_XTD1_VAC/MONITOR/C20303V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20402V

Instance id: | SA2_XTD1_VAC/MONITOR/C20402V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20502V

Instance id: | SA2_XTD1_VAC/MONITOR/C20502V
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

##### PNACT

[add component documentation]

###### V20000M

Instance id: | SA2_XTD1_VAC/PNACT/V20000M
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20010_VS20020, VAC_TO_MPS_USER, VS20010_VS20020, SA2_XTD1_VAC_PNACT_V20000M_INTERLOCK, SA2_MAIN, SA2_OVERVIEW_VACUUM_OLD, SA2_MAIN, SA2_MAIN, MPS_TEST, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_MAIN, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_MAIN, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, VS20010_VS20020_OLD, SA2_MAIN, SA2_OVERVIEW_VACUUM, VAC_TO_MPS, SA2_MAIN, VAC_TO_MPS_USER, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, VS20010_VS20020_OLD, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### C20503G_B1_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_B1_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_B1_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_B1_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_B1_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_B1_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_B1_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_B1_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_C2_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_C2_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20503G_C2_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/C20503G_C2_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20010C_I

Instance id: | SA2_XTD1_VAC/SWITCH/G20010C_I
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20010C_R

Instance id: | SA2_XTD1_VAC/SWITCH/G20010C_R
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20020C_I

Instance id: | SA2_XTD1_VAC/SWITCH/G20020C_I
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20020C_R

Instance id: | SA2_XTD1_VAC/SWITCH/G20020C_R
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20030C_I

Instance id: | SA2_XTD1_VAC/SWITCH/G20030C_I
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20030C_R

Instance id: | SA2_XTD1_VAC/SWITCH/G20030C_R
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20040C_I

Instance id: | SA2_XTD1_VAC/SWITCH/G20040C_I
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20040C_R

Instance id: | SA2_XTD1_VAC/SWITCH/G20040C_R
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20141P_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/G20141P_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20141P_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20141P_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20142C_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/G20142C_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/G20142C_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, VS20040_SOLID-ATT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20142C_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/G20142C_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20040_SOLID-ATT_MKS_GAUGES_OLD, Timeline_GaugeRelay, VS20040_SOLID-ATT_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20143P_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/G20143P_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20143P_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20143P_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20144C_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/G20144C_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/G20144C_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, VS20050_CRL_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20144C_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/G20144C_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20050_CRL_MKS_GAUGES_OLD, Timeline_GaugeRelay, VS20050_CRL_MKS_GAUGES, VS20040_VS20050
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20148P_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/G20148P_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20148P_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20148P_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20149C_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/G20149C_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/G20149C_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20149C_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/G20149C_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20070_XS2_SHUT_MKS_GAUGES_TEST_OLD, VS20070_XS2_SHUT_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LINAC_VAC_OK_FROMDESY

Instance id: | SA2_XTD1_VAC/SWITCH/LINAC_VAC_OK_FROMDESY
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_SCENES, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VS20010_VS20020, SA2_XTD1_VAC_PNACT_V20000M_INTERLOCK, SA2_XTD1_VAC_VALVE_V20020G_INTERLOCK, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, MVS_TEST, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, MVS_TEST, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, MVS_TEST, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OK_FROM_XGM

Instance id: | SA2_XTD1_VAC/SWITCH/OK_FROM_XGM
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PNACT_V20000M_CLOSE

Instance id: | SA2_XTD1_VAC/SWITCH/PNACT_V20000M_CLOSE
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_V20000M_PNACT_CLOSE_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS_DCTRL_V20000M_PNACT_CLOSE_INTERLOCK
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### PNACT_V20000M_OPEN

Instance id: | SA2_XTD1_VAC/SWITCH/PNACT_V20000M_OPEN
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### V20010F_CTRL2_READY

Instance id: | SA2_XTD1_VAC/SWITCH/V20010F_CTRL2_READY
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_CTRL_READY

Instance id: | SA2_XTD1_VAC/SWITCH/V20010F_CTRL_READY
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_IS_CLOSED

Instance id: | SA2_XTD1_VAC/SWITCH/V20010F_IS_CLOSED
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_IS_OPEN

Instance id: | SA2_XTD1_VAC/SWITCH/V20010F_IS_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, VS20010_VS20020, VS20010_VS20020_OLD, V20010F_OLD, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, VS20010_VS20020, VS20010_VS20020, V20010F, V20010F, V20010F, VS20010_VS20020_OLD, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20010F_IS_READY

Instance id: | SA2_XTD1_VAC/SWITCH/V20010F_IS_READY
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN_copy, SA2_FAST_VALVES, SA2_VACUUM, SA2_MAIN
Scenes: | V20010F, V20010F, V20010F, V20010F_OLD, V20010F, V20010F, V20010F, V20010F, V20010F
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_B1_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_B1_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_B1_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_B1_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_B1_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_C2_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_C2_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20405G_C2_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/C20405G_C2_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20146P_RLY1

Instance id: | SA2_XTD1_VAC/SWITCH/G20146P_RLY1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20146P_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20146P_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_RLY2

Instance id: | SA2_XTD1_VAC/SWITCH/G20147C_RLY2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_RLY3

Instance id: | SA2_XTD1_VAC/SWITCH/G20147C_RLY3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_RLY4

Instance id: | SA2_XTD1_VAC/SWITCH/G20147C_RLY4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20147C_RLY_IL

Instance id: | SA2_XTD1_VAC/SWITCH/G20147C_RLY_IL
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | VS20060_PRE-ABS_MKS_GAUGES, VS20060_VS20070
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TPUMP

[add component documentation]

###### P20050T

Instance id: | SA2_XTD1_VAC/TPUMP/P20050T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20070T

Instance id: | SA2_XTD1_VAC/TPUMP/P20070T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TPUPMS_ERROR, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20110T

Instance id: | SA2_XTD1_VAC/TPUMP/P20110T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TPUPMS_ERROR, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TURBO_FAILURE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20130T

Instance id: | SA2_XTD1_VAC/TPUMP/P20130T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, 20190702-SA2_DPS_FV_Assesment, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VALVE

[add component documentation]

###### V20000M

Instance id: | SA2_XTD1_VAC/VALVE/V20000M
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, VS20010_VS20020, SA2_XTD1_VAC_PNACT_V20000M_INTERLOCK, SA2_OVERVIEW_VACUUM, SA2_MAIN, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_MAIN, SA2_MAIN, MPS_TEST, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_MAIN, SA2_OVERVIEW_VACUUM, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, SA2_MAIN, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_MAIN, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS, SA2_MAIN, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_MAIN_BKR-wallpaper, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, VAC_TO_MPS, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20010_VS20020, BiancaTest2, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20020G

Instance id: | SA2_XTD1_VAC/VALVE/V20020G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20020G_INTERLOCK, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM, VS20010, VS20010, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20030G

Instance id: | SA2_XTD1_VAC/VALVE/V20030G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, SA2_XTD1_VAC_DP_XGM_DP, VAC_TO_MPS_USER, TEST_EXPERT_VIEW, VS20010_VS20020, SA2_XTD1_VAC_VALVE_V20030G_INTERLOCK, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM_OLD, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, VAC_TO_MPS_EXPERT, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, VS20010_VS20020, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, VS20010_VS20020, VS20010_VS20020, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VAC_TO_MPS_USER_OLD, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20010_VS20020, VS20010_VS20020, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20040G

Instance id: | SA2_XTD1_VAC/VALVE/V20040G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20050A

Instance id: | SA2_XTD1_VAC/VALVE/V20050A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20060A

Instance id: | SA2_XTD1_VAC/VALVE/V20060A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20070A

Instance id: | SA2_XTD1_VAC/VALVE/V20070A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20080G

Instance id: | SA2_XTD1_VAC/VALVE/V20080G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20140G

Instance id: | SA2_XTD1_VAC/VALVE/V20140G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20150A

Instance id: | SA2_XTD1_VAC/VALVE/V20150A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20160A

Instance id: | SA2_XTD1_VAC/VALVE/V20160A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20170A

Instance id: | SA2_XTD1_VAC/VALVE/V20170A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20180G

Instance id: | SA2_XTD1_VAC/VALVE/V20180G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20190G

Instance id: | SA2_XTD1_VAC/VALVE/V20190G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, SA2_XTD1_VAC_DP_XGM_DP, VAC_TO_MPS_USER, TEST_EXPERT_VIEW, SA2_XTD1_VAC_VALVE_V20190G_INTERLOCK, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20040_VS20050, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20040_VS20050, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, VAC_TO_MPS_EXPERT, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VAC_TO_MPS_USER_OLD, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, VS20040_VS20050, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20200G

Instance id: | SA2_XTD1_VAC/VALVE/V20200G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_XTD1_VAC_VALVE_V20200G_INTERLOCK, VS20040_VS20050, VS20040_VS20050, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20040_VS20050, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20210G

Instance id: | SA2_XTD1_VAC/VALVE/V20210G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN_copy, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, SA2_XTD1_VAC_VALVE_V20210G_INTERLOCK, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20040_VS20050, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VS20060_VS20070, VS20040_VS20050_OLD, VS20040_VS20050, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20040_VS20050_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20040_VS20050, VS20060_VS20070, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER_OLD, VS20040_VS20050_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20040_VS20050, VS20060_VS20070, VS20060_VS20070, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20220G

Instance id: | SA2_XTD1_VAC/VALVE/V20220G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_VACUUM, SA2_MAIN, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_VALVE_V20000M_INTERLOCK, VAC_TO_MPS_USER, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_EXPERT, VAC_TO_MPS_EXPERT, VS20060_VS20070, SA2_XTD1_VAC_VALVE_V20220G_INTERLOCK, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM_OLD, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_EXPERT, VS20060_VS20070, SA2_OVERVIEW_VACUUM, VS20060_VS20070, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER_OLD, VS20060_VS20070_OLD, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_EXPERT, VAC_TO_MPS_USER, SA2_OVERVIEW_VACUUM, VS20060_VS20070, VS20060_VS20070, VAC_TO_MPS_USER_OLD, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, SA2_OVERVIEW_VACUUM, VAC_TO_MPS_USER, VAC_TO_MPS_USER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### FVALVE

[add component documentation]

###### V20010F

##### FV

[add component documentation]

###### V20010F

##### VSWITCH

[add component documentation]

###### PNACT_V20000M_CLOSE

Instance id: | SA2_XTD1_VAC/VSWITCH/PNACT_V20000M_CLOSE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### PNACT_V20000M_OPEN

Instance id: | SA2_XTD1_VAC/VSWITCH/PNACT_V20000M_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### WATCHDOG

[add component documentation]

##### MDL

[add component documentation]

###### BN_IMGFEL

Instance id: | SA2_XTD1_WATCHDOG/MDL/BN_IMGFEL
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_IMGFEL_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### DIAMOND_IMGFEL

Instance id: | SA2_XTD1_WATCHDOG/MDL/DIAMOND_IMGFEL
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_IMGFEL_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### GOS_IMGSR

Instance id: | SA2_XTD1_WATCHDOG/MDL/GOS_IMGSR
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### OTRC_SCREEN_STATUS

Instance id: | SA2_XTD1_WATCHDOG/MDL/OTRC_SCREEN_STATUS
Class id: | GenericEstimator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### YAG_IMGFEL

Instance id: | SA2_XTD1_WATCHDOG/MDL/YAG_IMGFEL
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_IMGFEL_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### YAG_IMGSR

Instance id: | SA2_XTD1_WATCHDOG/MDL/YAG_IMGSR
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_XTD1_IMGSR_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### DIAMOND_IMGTR

Instance id: | SA2_XTD1_WATCHDOG/MDL/DIAMOND_IMGTR
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_XTD1_IMGTR_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### YAG_IMGTR

Instance id: | SA2_XTD1_WATCHDOG/MDL/YAG_IMGTR
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_XTD1_IMGTR_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### SI_ATT0

Instance id: | SA2_XTD1_WATCHDOG/MDL/SI_ATT0
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### BeamPosition_IMGFEL

Instance id: | SA2_XTD1_WATCHDOG/MDL/BeamPosition_IMGFEL
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_IMGFEL_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### IMAGERS_DS_ATT

Instance id: | SA2_XTD1_WATCHDOG/MDL/IMAGERS_DS_ATT
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_Watchdog_overview_screens, SA2_XTD1_ATT1, SA2_XTD1_ATT1_test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- dostartAll:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### IMAGER_DS_ATT

Instance id: | SA2_XTD1_WATCHDOG/MDL/IMAGER_DS_ATT
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-05-12T13:52:39.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Haufs, Giovanetti
Latest tag: | 1.10.5-2.10.0
Deployment tag: | 1.10.5-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!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

0.0.3-2.6.1

Created: | 2019-09-26T16:51:16.000Z
Author: | Denys Mamchyk
Notes: | estimator+actuator version to be tested, created from branch

###### YAG_IMGFEL0

Instance id: | SA2_XTD1_WATCHDOG/MDL/YAG_IMGFEL0
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-05-12T13:52:39.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Haufs, Giovanetti
Latest tag: | 1.10.5-2.10.0
Deployment tag: | 1.10.5-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!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

0.0.3-2.6.1

Created: | 2019-09-26T16:51:16.000Z
Author: | Denys Mamchyk
Notes: | estimator+actuator version to be tested, created from branch

###### ABSORB_MONITOR

###### IMAGERS_DS_ATT_OPEN

Instance id: | SA2_XTD1_WATCHDOG/MDL/IMAGERS_DS_ATT_OPEN
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_XTD1_ATT1_test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doopenA1:
    The slot allows to run assigned action manually
- doopenA2:
    The slot allows to run assigned action manually
- doopenA3:
    The slot allows to run assigned action manually
- doopenA4:
    The slot allows to run assigned action manually
- doopenA5:
    The slot allows to run assigned action manually
- doopenA6:
    The slot allows to run assigned action manually
- doopenA7:
    The slot allows to run assigned action manually
- doopenA8:
    The slot allows to run assigned action manually
- doopenA9:
    The slot allows to run assigned action manually
- doemergencyStopA1:
    The slot allows to run assigned action manually
- doemergencyStopA2:
    The slot allows to run assigned action manually
- doemergencyStopA3:
    The slot allows to run assigned action manually
- doemergencyStopA4:
    The slot allows to run assigned action manually
- doemergencyStopA5:
    The slot allows to run assigned action manually
- doemergencyStopA6:
    The slot allows to run assigned action manually
- doemergencyStopA7:
    The slot allows to run assigned action manually
- doemergencyStopA8:
    The slot allows to run assigned action manually
- doemergencyStopA9:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### IMAGERS_DS_ATT_OPEN2

Instance id: | SA2_XTD1_WATCHDOG/MDL/IMAGERS_DS_ATT_OPEN2
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_XTD1_ATT1_test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doopenA1:
    The slot allows to run assigned action manually
- doopenA2:
    The slot allows to run assigned action manually
- doopenA3:
    The slot allows to run assigned action manually
- doopenA4:
    The slot allows to run assigned action manually
- doopenA5:
    The slot allows to run assigned action manually
- doopenA6:
    The slot allows to run assigned action manually
- doopenA7:
    The slot allows to run assigned action manually
- doopenA8:
    The slot allows to run assigned action manually
- doopenA9:
    The slot allows to run assigned action manually
- domoveTarget:
    The slot allows to run assigned action manually
- doemergencyStopA1:
    The slot allows to run assigned action manually
- doemergencyStopA2:
    The slot allows to run assigned action manually
- doemergencyStopA3:
    The slot allows to run assigned action manually
- doemergencyStopA4:
    The slot allows to run assigned action manually
- doemergencyStopA5:
    The slot allows to run assigned action manually
- doemergencyStopA6:
    The slot allows to run assigned action manually
- doemergencyStopA7:
    The slot allows to run assigned action manually
- doemergencyStopA8:
    The slot allows to run assigned action manually
- doemergencyStopA9:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

###### OPEN_ATT

Instance id: | SA2_XTD1_WATCHDOG/MDL/OPEN_ATT
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

#### XGM

[add component documentation]

##### ASENS

[add component documentation]

###### G20096F

Instance id: | SA2_XTD1_XGM/ASENS/G20096F
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, Graph, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Overview, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G30096F_RNC

Instance id: | SA2_XTD1_XGM/ASENS/G30096F_RNC
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20106D_ANAPOS

Instance id: | SA2_XTD1_XGM/ASENS/V20106D_ANAPOS
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20106D_SIGNAL

Instance id: | SA2_XTD1_XGM/ASENS/V20106D_SIGNAL
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### DCTRL

[add component documentation]

###### INHIBIT

Instance id: | SA2_XTD1_XGM/DCTRL/INHIBIT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OK_TO_VAC

Instance id: | SA2_XTD1_XGM/DCTRL/OK_TO_VAC
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20101S

Instance id: | SA2_XTD1_XGM/DCTRL/V20101S
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20102S

Instance id: | SA2_XTD1_XGM/DCTRL/V20102S
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20103S

Instance id: | SA2_XTD1_XGM/DCTRL/V20103S
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20104S

Instance id: | SA2_XTD1_XGM/DCTRL/V20104S
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20105S

Instance id: | SA2_XTD1_XGM/DCTRL/V20105S
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20110S_COIL

Instance id: | SA2_XTD1_XGM/DCTRL/V20110S_COIL
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, ShutOff - experts only, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, ShutOff - experts only, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, ShutOff - experts only, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Overview, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### GAUGE

[add component documentation]

###### G20090P

Instance id: | SA2_XTD1_XGM/GAUGE/G20090P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20091M

Instance id: | SA2_XTD1_XGM/GAUGE/G20091M
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20100P

Instance id: | SA2_XTD1_XGM/GAUGE/G20100P
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### PUMP

[add component documentation]

###### P20090S

##### SWITCH

[add component documentation]

###### FROM_VACDPS_OK

Instance id: | SA2_XTD1_XGM/SWITCH/FROM_VACDPS_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | INTERLOCK_VAC_XGM, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20092S_N2

Instance id: | SA2_XTD1_XGM/SWITCH/G20092S_N2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20093S_NE

Instance id: | SA2_XTD1_XGM/SWITCH/G20093S_NE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20094S_KR

Instance id: | SA2_XTD1_XGM/SWITCH/G20094S_KR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20095S_XE

Instance id: | SA2_XTD1_XGM/SWITCH/G20095S_XE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_CLOSE

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_CLOSE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_ERROR

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_ERROR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_ON

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_ON
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_OPEN

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_POS

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_POS
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_SENERROR

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_SENERROR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20096F_STATUS

Instance id: | SA2_XTD1_XGM/SWITCH/G20096F_STATUS
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G20099S

Instance id: | SA2_XTD1_XGM/SWITCH/G20099S
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### G30096F_READY

Instance id: | SA2_XTD1_XGM/SWITCH/G30096F_READY
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20110S_OPEN

Instance id: | SA2_XTD1_XGM/SWITCH/V20110S_OPEN
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, ShutOff - experts only, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, TEST_EXPERT_VIEW, ShutOff - experts only, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, ShutOff - experts only, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Vacuum, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_XGM_Overview, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, TEST_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD1_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TPUMP

[add component documentation]

###### P20080T

Instance id: | SA2_XTD1_XGM/TPUMP/P20080T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### P20100T

Instance id: | SA2_XTD1_XGM/TPUMP/P20100T
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enablePumpingStation:
    Enables the pumping station (does not start pumping yet)
- disablePumpingStation:
    Disables the pumping station
- startPumping:
    Starts the pump
- stopPumping:
    Stops the pump
- startStandby:
    Start Standby operation
- stopStandby:
    Stop Standby operation
- remotePriorityOn:
    Enable remote control
- remotePriorityOff:
    Disable remote control
- startHeating:
    Start Heating
- stopHeating:
    Stop Heating
- resetController:
    reset error on controller
- startVenting:
    Start Venting
- stopVenting:
    Stop Venting
- enableRtsCts:
    Enable RTS/CTS
- enableXonXoffTx:
    Enable XOn/XOff supported tx data
- enableXonXoffRx:
    Enable XOn/XOff supported rx data
- enableFifoCont:
    Enable send FIFO data continuous
- enableTransferOpt:
    Enable transfer rate optimization
- baudRate:
    Baud Rate: 1=300 2=600 3=1200 4=2400 5=4800 6=9600 7=19200 8=38400 9=57600 10=115200 Baud.
- dataFrame:
    Data Frame: 1=7E1 2=7O1 3=8N1 4=8E1 5=8O1 9=7E2 10=7O2 11=8N2 12=8E2 13=8O2.
- bufferFull:
    Buffer Full Notification.
- serialString:
    Send serial string.
- serialCheck:
    Check serial protocol command value (reads back string from command function window (ASerP input value)
- heatingOnOff:
    Heating On/Off.
- standbyOnOff:
    Standby On/Off.
- pumpingStationOnOff:
    Pumping station On/Off.
- enableVenting:
    Enable venting.
- remotePriority:
    Remote priority.
- isRPMExceed:
    isRPMExceed
- runUpTimeOnOff:
    Run-up time control
- errorAck:
    Error Acknowledgment.
- rotationSpeedSwitchpoint:
    Rotation speed switch point: 0 = switch point 1 only; 1 = switch points 1 and 2.
- configDO2:
    Configure DO2: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- motorPump:
    Motor pump.
- configDO1:
    Configure DO1: 0 = Rot. speed switch point attained; 1 = No error; 2 = Error; 3 = Warning 4 = Error and/or warning; 5 = Set speed attained; 6 = Pump on; 7 = Pump accelerates; 8 = Pumpe decelerates 9 = always 0; 10 = always 1; 11 = Remote priority active; 12 = Heating; 13 = Backing pump 14 = Sealing gas; 15 = Pumping station
- backingPump:
    Operation mode backing pump: 0 = Continuous; 1 = Intermittend; 2 = Delayed switch on
- rotationSpeedSettingMode:
    Rotation speed setting mode: 0 = Off; 1 = On. This setting is needed for Standby operation.
- gasMode:
    Gas Mode: 0 = Heavy; 1 = Light; 2 = Helium.
- ventingMode:
    Venting mode: 0 = Delayed Venting; 1 = No Venting; 2 = Direct Venting.
- accessoryConnectionA1:
    Accessory connection A1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB1:
    Accessory connection B1: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionA2:
    Accessory connection A2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- accessoryConnectionB2:
    Accessory connection B2: 0 = Fan (continuous operation); 1 = Venting valve, normally closed; 2 = Heating; 3 = Backing pump; 4 = Fan (temperature controlled); 5 = Sealing gas; 6 = always 0; 7 = always 1; 8 = Power failure venting unit.
- sealingGasOnOff:
    Sealing gas On/Off.
- configOutputA01:
    Configure output AO1: 0 = Actual rotation speed; 1 = Power; 2 = Current; 3 = always 0 V; 4 = always 10 V.
- controlInterface:
    Control interface: 1 = Remote; 2 = RS485; 4 = PV.can; 8 = Field bus; 16 = E74; 255 = Unlock interface selection.
- interfaceSelectionLocked:
    Lock interface selection.
- configInputDI1:
    Configure Input DI1: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- configInputDI2:
    Configure Input DI2: 0 = Deactivated; 1 = Enable venting; 2 = Heating; 3 = Sealing gas; 4 = Run-up time control; 5 = Rotation speed setting mode; 6 = Motor.
- rotationSpeedSwitchPointAttained:
    Rotation speed switch point attained.
- errorCode:
    Error code.
- overtTempDriveUnit:
    Over temperature drive unit.
- overtTempPump:
    Over temperature pump.
- setSpeedAttained:
    Set speed attained.
- pumpAccelerates:
    Pump accelerates.
- setRotationSpeed:
    Set rotation speed.
- actualRotationSpeed:
    Actual rotation speed.
- driveCurrent:
    Drive current.
- operatingHoursPump:
    Operating hours pump.
- firmwareVersion:
    Firmware version drive unit.
- driveVoltage:
    Drive voltage.
- operatingHoursDriveUnit:
    Operating hours drive unit.
- nominalRotationSpeed:
    Nominal rotation speed.
- drivePower:
    Drive power.
- pumpCycles:
    Pump cycles.
- temperatureElectronic:
    Temperature electronics.
- temperaturePumpBottom:
    Temperature pump bottom part.
- acceleration:
    Acceleration [rpm/s].
- temperatureBearing:
    Temperature bearing.
- temperatureMotor:
    Temperature motor.
- driveUnitName:
    Name of the electronic drive unit.
- hwVersionDriveUnit:
    Hardware version of electronic drive unit.
- errorCodeHistory1:
    Error code history 1.
- errorCodeHistory2:
    Error code history 2.
- errorCodeHistory3:
    Error code history 3.
- errorCodeHistory4:
    Error code history 4.
- errorCodeHistory5:
    Error code history 5.
- errorCodeHistory6:
    Error code history 6.
- errorCodeHistory7:
    Error code history 7.
- errorCodeHistory8:
    Error code history 8.
- errorCodeHistory9:
    Error code history 9.
- errorCodeHistory10:
    Error code history 10.
- setRotationSpeedRpm:
    Set rotation speed [rpm].
- actualRotationSpeedRpm:
    Actual rotation speed [rpm].
- nominalRotationSpeedRpm:
    Nominal rotation speed [rpm].
- targetRunupTime:
    The run-up time set value.
- rotationSpeedSwitchpoint1:
    The rotation speed switch point 1.
- rotationSpeedSettingModeValue:
    The value of the rotation speed setting mode.
- powerConsumptionValue:
    The value of power consumption.
- switchOffThresholedBKP:
    Switching off threshold backing pump in intermittent mode.
- switchOnThresholedBKP:
    Switching on threshold backing pump in intermittent mode.
- rotationSpeedStandBy:
    The rotation speed at stand-by.
- rotationSpeedSwitchpoint2:
    The rotation speed switch point 2.
- rotationSpeedDelayedVenting:
    The venting rotation speed at delayed venting.
- ventingTimeDelayedVenting:
    The venting time at delayed venting.
- nominalRotationSpeedConfirmation:
    Confirmation of nominal rotation speed.
- rs485DeviceAddress:
    The address of the RS485 device.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VALVE

[add component documentation]

###### V20090V

Instance id: | SA2_XTD1_XGM/VALVE/V20090V
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | INTERLOCK_VAC_XGM, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20100G

Instance id: | SA2_XTD1_XGM/VALVE/V20100G
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20120A

Instance id: | SA2_XTD1_XGM/VALVE/V20120A
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### V20130V

Instance id: | SA2_XTD1_XGM/VALVE/V20130V
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy, SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN
Scenes: | INTERLOCK_VAC_XGM, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Vacuum, SA2_XTD1_XGM_Overview, INTERLOCK_VAC_XGM, INTERLOCK_VAC_XGM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### XGM

[add component documentation]

###### DOOCS

Instance id: | SA2_XTD1_XGM/XGM/DOOCS
Class id: | DoocsXGM
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/doocsDevices
Last modified: | 2021-09-28T22:00:13.934+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Ehsan, Ehsanw
Latest tag: | 1.8.16-2.11.1
Deployment tag: | 1.8.16-2.11.1
Installed tag: | 1.8.12-2.10.4
Projects: | SA2_DOOCS_copy, SA2_DOOCS, SA2_MAIN, SA2_DOOCS, SA2_MAIN_copy, SA2_DOOCS
Scenes: | Correlation, Beam_Position_Correlator, SA2_XTD1_UND/MDL/GAINCURVE_SCANNOV08|scene, SA2_XTD1_UND/MDL/GAINCURVE_SCANNOV08|scene, SA2_XTD1_UND/MDL/GAINCURVE_SCAN_scene0, SA2_XTD1_UND/MDL/GAINCURVE_SCAN_scene, SA2_XTD6_IMGPII45-1_AVG, SA2_MAIN, SA2_XTD1_XGM-XGM-DOOCS, SA2_XTD1_XGM-XGM-DOOCS, SA2_XTD1_XGM-XGM-DOOCS, SA2_XTD1_XGM_OVERVIEW, SA2_MAIN, SA2_IMGFEL_MAIN, SA2_XTD1_UND/MDL/GAINCURVE_SCAN_custom0, test XGMvsIMGPII45-1, SA2_XTD1_XGM_OVERVIEW_old, SA2_Gotthard, SA2_XTD1_XGM_OVERVIEW, XGM_IMGPROC_correlation, SA2_XTD1_UND/MDL/GAINCURVE_SCANTEST|scene, SA2_XTD1_XGM_OVERVIEW, Gain-Curve-Scan, SA2_MAIN, SA2_MAIN, Positioncorr, SA2_XTD1_UND/MDL/GAINCURVE_SCAN_scene, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp_CK, MID_XTD6_IMGPI_AVG, SA2_XTD6_IMGPII45-1_MAIN_New, SA2_IMGFEL_MAIN_New, MID_XTD6_IMGPI_MAIN_New, test FELIMGvsXGM, HED_XTD6_IMGPI_MAIN_New, SA2_XGMvsFELIMG, SA2_MAIN_BKR-wallpaper, SA2_XTD1_XGM/XGM/DOOCS, XTD1XGM vs XTD6XGM, SA2_Spectrum, SA2_XTD1_UND/MDL/GAINCURVE_SCANNOV08_backup|scene, SA2_XTD1_UND-MDL-GAINCURVE_SCAN-scene, SA2_XTD6_IMGPII45-2_MAIN_New, SA2_XTD1_UND/MDL/GAINCURVE_SCAN|scene, XGM-vs-MCP, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp1_CK, SA1_XTD2_XGM_New0, SA2_HIREX_MAIN, SA2_HIREX_Main, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, 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.16-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- reset:
    Resets the device in case of an error
- location:
    Location identifies DOOCS server like XGM.2643.T9
- pollingInterval:
    Polling Interval to get updated values from DOOCS.
- controlData:
    Slow data parameters

Release History
1.8.16-2.11.1

Created: | 2021-08-25T13:04:03.000+02:00
Author: | Wajid Ehsan
Notes: | Doocs Mirror fast data generic plot

1.8.15-2.11.1

Created: | 2021-08-09T19:41:27.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: Authorization mask

1.8.14-2.11.1

Created: | 2021-06-08T15:36:50.000+02:00
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T14:26:44.000+02:00
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T12:20:05.000+02:00
Author: | mamchykd
Notes: | FIX: reset slot of DoocsPhaseshifter device is available in UNKNOWN state (request of HED)

1.8.11-2.10.4

Created: | 2021-04-21T16:09:17.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T15:47:03.000+01:00
Author: | Gabriele Giovanetti
Notes: | Summary: * update doocsapi to 2.4.1-2.10.0; * add low charge resolution.

1.8.9-2.10.0

Created: | 2021-01-12T13:38:56.000+01:00
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T08:05:35.000+01:00
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T16:46:42.000+01:00
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T16:11:02.000+02:00
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T07:37:53.000+02:00
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T20:09:47.000+02:00
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T09:18:47.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Add/write permission to keys at schema injection according to the permission in DOOCS.

1.8.4-2.9.1

Created: | 2020-09-02T09:35:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T12:18:01.000+02:00
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T11:20:59.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Input channel readout aligned with timeserver changes from tag 2.7.4-2.9.1. It is recommended to replace previous tags.

1.8.1-2.9.1

Created: | 2020-08-21T13:49:45.000+02:00
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T14:42:42.000+02:00
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T17:10:21.000+02:00
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

###### DOOCS_METRIC_TEST

Instance id: | SA2_XTD1_XGM/XGM/DOOCS_METRIC_TEST
Class id: | DoocsXGM
Host: | exflcon224
Alias: | sa2-br-sys-con-11
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.14-2.11.1
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- 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

##### MDL

[add component documentation]

###### GAS_TYPE

Instance id: | SA2_XTD1_XGM/MDL/GAS_TYPE
Class id: | XGMGasType
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/XGMGasType
Last modified: | 2021-05-27T09:52:57.000+02:00
Created at: | 2018-05-24T15:59:25.000+02:00
Main authors: | Parenti, Hauf, Wajid
Latest tag: | 1.0.4-2.11.0
Deployment tag: | 1.0.4-2.11.0
Projects: | SA2_XTD1_XGM, SA2_VAC_XGM, SA2_VACUUM, SA2_MAIN_copy
Scenes: | SA2_XTD1_XGM_OVERVIEW_old, SA2_XTD1_XGM_OVERVIEW, SA2_XTD1_XGM_OVERVIEW, SA2_XTD1_XGM_Vacuum
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- nitrogen:
    Device related with NITROGEN
- neon:
    Device related with NEON
- krypton:
    Device related with KRYPTON
- xenon:
    Device related with XENON
- vacuum:
    Device related with VACUUM

Release History
1.0.4-2.11.0

Created: | 2021-05-25T14:51:41.000+02:00
Author: | Alessandro Silenzi
Notes: | use async/await and implemented tests

1.0.3-2.10.0

Created: | 2020-11-27T09:35:27.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.0.2-2.7.0

Created: | 2020-01-28T13:50:11.000+01:00
Author: | Valerii Bondar
Notes: | Tag is recommended for deployment. No additional tests needed as compared to previous tag No change in schema as compared with previous tag

1.0.1-2.7.0

Created: | 2020-01-27T15:19:14.000+01:00
Author: | Valerii Bondar
Notes: | Tag is recommended for deployment. * No additional tests needed as compared to previous tag * No change in schema as compared with previous tag

1.0.0-2.2.3

Created: | 2018-06-06T16:22:52.000+02:00
Author: | Wajid Ehsan
Notes: | XGM Gas type

#### DOOCS

[add component documentation]

##### CAM

[add component documentation]

###### OTRC_2576_T6

##### MDL

[add component documentation]

###### OTRC_2576_T6

##### PROC

[add component documentation]

###### OTRC_2576_T6

Instance id: | SA2_XTD1_DOOCS/PROC/OTRC_2576_T6
Class id: | ImageProcessor
Host: | exflcon72n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | Test_correlation
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### DOOCS

[add component documentation]

###### OTRC_SCREEN_STATUS

#### SRA

[add component documentation]

##### SLIT

[add component documentation]

###### MDL

[add component documentation]

MAIN

Instance id: | SA2_XTD1_SRA_SLIT/MDL/MAIN
Class id: | SlitSystem
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/slitSystem
Last modified: | 2021-01-13T14:43:03.000+01:00
Created at: | 2016-11-16T14:10:53.000+01:00
Main authors: | Marsa, Carinan, Hickin
Latest tag: | 2.5.3-2.10.0
Deployment tag: | 2.5.3-2.10.0
Projects: | SA2_XTD1_SRA_SLIT
Scenes: | SA2_XDT1_SRA_SLIT, SA2_MAIN, SASE2_SRA, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- offsetLeft:
    Left offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetRight:
    Right offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetTop:
    Top offset of motor, can only be set before instantiation or via the calibrate slot.
- offsetBot:
    Bot offset of motor, can only be set before instantiation or via the calibrate slot.
- reverseLeft:
    Reverse direction of Left motor axis in relation to X. Can only be set before instantiation.
- reverseRight:
    Reverse direction of Right motor axis in relation to X. Can only be set before instantiation.
- reverseTop:
    Reverse direction of Top motor axis in relation to Y. Can only be set before instantiation.
- reverseBottom:
    Reverse direction of Bot motor axis in relation to Y, can only be set before instantiation.
- positionIn:
    The defined in position. Save parameters by editing before instatiation.
- positionOut:
    The defined in position. Save parameters by editing before instatiation.
- motor:
    The motor InstanceId of the motors of the slit system.
- open:
    Open slit one step
- close:
    Close slit one step
- right:
    Move slit one step in +X
- left:
    Move slit one step in -X
- up:
    Move slit one step in Y
- down:
    Move slit one step in -Y
- closeX:
    Close slit one step in X
- openX:
    Open slit one step in X
- openY:
    Open slit one step in Y
- closeY:
    Close slit one step in Y
- calibrate:
    Set the motors offset once the slit device is CENTERED and CLOSED
- calibrateX:
    Set the motors offset in horizontal once the slit device is CENTERED and CLOSED
- calibrateY:
    Set the motors offset in vertical once the slit device is CENTERED and CLOSED
- availableScenes:
    Scenes from the Slit System

Release History
2.5.3-2.10.0

Created: | 2021-01-13T14:43:36.000+01:00
Author: | David Hickin
Notes: |

2.5.2-2.10.0

Created: | 2020-12-23T16:44:35.000+01:00
Author: | David Hickin
Notes: |

2.5.1-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: | Summary: add CI

2.5.0-2.10.0

Created: | 2020-11-19T15:24:45.000+01:00
Author: | Dennis Goeries
Notes: |

2.4.0-2.2.4

Created: | 2018-06-07T09:11:44.000+02:00
Author: | Dennis Goeries
Notes: |

2.3.5-2.2.1

Created: | 2018-04-27T11:11:40.000+02:00
Author: | Dennis Goeries
Notes: |

2.3.4-2.2.1

Created: | 2018-03-22T14:15:20.000+01:00
Author: | Dennis Goeries
Notes: |

2.3.3-2.2.1

Created: | 2018-03-15T10:55:54.000+01:00
Author: | Dennis Goeries
Notes: |

2.3.2-2.2.1

Created: | 2018-03-06T13:08:58.000+01:00
Author: | Dennis Goeries
Notes: |

2.3.1-2.2.1

Created: | 2018-02-19T18:21:55.000+01:00
Author: | Dennis Goeries
Notes: | Scene update

2.3.0-2.2.1

Created: | 2018-02-19T13:27:25.000+01:00
Author: | Alessandro Silenzi
Notes: | Included SPB interface and default scenes

2.2.0-2.2.0

Created: | 2017-12-12T17:37:51.000+01:00
Author: | Dennis Goeries
Notes: |

2.1.9-2.1.16

Created: | 2017-10-23T13:42:52.000+02:00
Author: | David Hickin
Notes: |

2.1.8-2.1.14

Created: | 2017-08-17T19:23:39.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.7-2.1.14

Created: | 2017-08-14T15:41:33.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.6-2.1.12

Created: | 2017-07-19T15:28:26.000+02:00
Author: | Dennis Goeries
Notes: |

2.1.5

Created: | 2017-03-02T18:29:17.000+01:00
Author: | Dennis Goeries
Notes: | Migrated slitSystem

#### PREABS1

[add component documentation]

##### DCTRL

[add component documentation]

###### LED_POWER

Instance id: | SA2_XTD1_PREABS1/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPEN

Instance id: | SA2_XTD1_PREABS1/DCTRL/OPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### IN_BEAM

Instance id: | SA2_XTD1_PREABS1/SWITCH/IN_BEAM
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OUT_BEAM

Instance id: | SA2_XTD1_PREABS1/SWITCH/OUT_BEAM
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD1_PREABS1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### PREABS2

[add component documentation]

##### DCTRL

[add component documentation]

###### LED_POWER

Instance id: | SA2_XTD1_PREABS2/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OPEN

Instance id: | SA2_XTD1_PREABS2/DCTRL/OPEN
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### SWITCH

[add component documentation]

###### IN_BEAM

Instance id: | SA2_XTD1_PREABS2/SWITCH/IN_BEAM
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### OUT_BEAM

Instance id: | SA2_XTD1_PREABS2/SWITCH/OUT_BEAM
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### TARGET

[add component documentation]

##### WATCHDOG

[add component documentation]

###### MDL

[add component documentation]

YAG_IMGFEL

Instance id: | SA2_XTD1_TARGET_WATCHDOG/MDL/YAG_IMGFEL
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Scenes: | SA2_XTD1_ATT1, SA2_XTD1_ATT1_test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doemergencyStop:
    The slot allows to run assigned action manually

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

#### PREABS

[add component documentation]

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD1_PREABS/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | SA2_XTD1_PREABS_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | SA2_XTD1_PREABS/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

### XTD2

[add component documentation]

#### DOOCS

[add component documentation]

##### PBLM

[add component documentation]

###### 2693L

###### 2693R

### XTD3

[add component documentation]

#### TOR

[add component documentation]

##### DOOCS

[add component documentation]

###### T3

### XTD5

[add component documentation]

#### TOR

[add component documentation]

##### DOOCS

[add component documentation]

###### T5

### XTD6

[add component documentation]

#### ABS

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_ABS/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_ABS/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### WATER

Instance id: | SA2_XTD6_ABS/TSENS/WATER
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLA1

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_COLA1/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_COLA1/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLA2

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_COLA2/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_COLA2/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLB2

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_COLB2/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_COLB2/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLB3

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_COLB3/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_COLB3/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### COLB4

[add component documentation]

##### TSENS

[add component documentation]

###### T1

Instance id: | SA2_XTD6_COLB4/TSENS/T1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### T2

Instance id: | SA2_XTD6_COLB4/TSENS/T2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### DOOCS

[add component documentation]

##### BAM

[add component documentation]

###### LCAT181_B1

###### LCAT1932M_TL

###### LCAT1932S_TL

###### LCAT392_B2

###### LCAT414_B2

###### LCAT47_I1

##### CAM

[add component documentation]

###### OTRC_2576_T6

Instance id: | SA2_XTD6_DOOCS/CAM/OTRC_2576_T6
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsCamera
Last modified: | 2020-02-27T15:21:07.000+01:00
Created at: | 2017-01-19T15:40:47.000+01:00
Main authors: | Hauf, Parenti, Esenov
Latest tag: | 1.0.3-2.7.0-16bit
Deployment tag: | 1.0.3-2.7.0-16bit
Accessible by: | CONTROLS, DA

Warning

Installation not found in a standard path!

[add instance documentation]

Release History
1.0.3-2.7.0-16bit

Created: | 2020-02-11T09:10:48.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch. Custom doocsapi dependency fix

1.0.2-2.7.0

Created: | 2020-02-11T08:27:00.000Z
Author: | Denys Mamchyk
Notes: | Tag from branch. DAQ-enabled branch customized for Transmissive Imagers with dependency fix

1.0.1-2.7.0

Created: | 2020-02-11T07:44:20.000Z
Author: | degon
Notes: | Tag from branch. DAQ-enabled branch customized for Transmissive Imagers

1.0.0-2.1.18

Created: | 2017-12-05T11:15:23.000Z
Author: | Andrea Parenti
Notes: |

1.0.0

Created: | 2014-05-20T16:27:56.000Z
Author: | Majank Kumar
Notes: | creating tagged release 1.0.0

##### MDL

[add component documentation]

###### OTRC_2576_T6

Instance id: | SA2_XTD6_DOOCS/MDL/OTRC_2576_T6
Host: | exflcon82n0
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsUndulator
Last modified: | 2020-02-12T08:35:26.000+01:00
Created at: | 2017-11-14T18:23:43.000+01:00
Main authors: | Parenti, Danilevski, Ehsan
Latest tag: | 2.1.0-2.6.4
Deployment tag: | 2.1.0-2.6.4
Installed tag: | 2.1.0-2.6.4
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
2.1.0-2.6.4

Created: | 2019-11-25T15:26:21.000Z
Author: | Yury Kirienko
Notes: | DAQ compliancy improved. Mandatory for all DOOCS BAM devices.

2.0.5-2.6.4

Created: | 2019-11-14T12:37:17.000Z
Author: | Andrea Parenti
Notes: | Use doocsapi version supporting CentOS 7.7

2.0.5-2.6.0

Created: | 2019-08-13T13:55:04.000Z
Author: | Alessandro Silenzi
Notes: | Ubuntu 18

2.0.5-2.3.1

Created: | 2019-03-12T11:44:32.000Z
Author: | Wajid Ehsan
Notes: | update Doocs to support CentOS 7.6

2.0.4-2.3.1

Created: | 2019-02-08T18:20:56.000Z
Author: | Wajid Ehsan
Notes: | Update DoocsApi Tag to 2.1.0-2.3.1

2.0.3-2.2.5

Created: | 2018-11-21T09:40:11.000Z
Author: | Wajid Ehsan
Notes: | Update DoocsApi Tag to 2.0.9-2.2.5

2.0.2-2.2.5

Created: | 2018-10-01T16:11:51.000Z
Author: | Cyril Danilevski
Notes: | Update Doocs API

2.0.2-2.2.4

Created: | 2018-06-19T11:28:21.000Z
Author: | Andrea Parenti
Notes: | FIX: stop polling thread and go to ERROR in case of DOOCS location unavailability FIX: harmonize states with other DOOCS devices (rename STARTED to ON) ADD: CI configuration

2.0.1-2.2.4

Created: | 2018-06-07T08:52:06.000Z
Author: | Andrea Parenti
Notes: | Update doocsapi for Karabo 2.2.4

2.0.0-2.2.2

Created: | 2018-04-05T15:01:21.000Z
Author: | Cyril Danilevski
Notes: |

1.2.0-2.2.1

Created: | 2018-02-23T11:08:01.000Z
Author: | Cyril Danilevski
Notes: | Only query the parameters that are presently available in DOOCS

1.1.1-2.2.1

Created: | 2018-01-26T08:38:28.000Z
Author: | Cyril Danilevski
Notes: | Make the MDL device more broker friendly

1.1.0-2.1.18

Created: | 2017-12-15T16:39:00.000Z
Author: | Cyril Danilevski
Notes: | Update the DOOCS API

1.0.0-2.1.18

Created: | 2017-12-01T13:02:21.000Z
Author: | Hugo Santos
Notes: |

##### PBLM

[add component documentation]

###### 2783L

###### 2783R

#### DPS1

[add component documentation]

##### SWITCH

[add component documentation]

###### S22020A

Instance id: | SA2_XTD6_DPS1/SWITCH/S22020A
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### DPS2

[add component documentation]

##### SWITCH

[add component documentation]

###### S22070A

Instance id: | SA2_XTD6_DPS2/SWITCH/S22070A
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW, SA2_XTD6_VAC_DP_XGM_DP_EXPERT_VIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### EPS

[add component documentation]

##### MONITOR

[add component documentation]

###### C20608E

Instance id: | SA2_XTD6_EPS/MONITOR/C20608E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20705E

Instance id: | SA2_XTD6_EPS/MONITOR/C20705E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20910E

Instance id: | SA2_XTD6_EPS/MONITOR/C20910E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21405E

Instance id: | SA2_XTD6_EPS/MONITOR/C21405E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21606E

Instance id: | SA2_XTD6_EPS/MONITOR/C21606E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21709E

Instance id: | SA2_XTD6_EPS/MONITOR/C21709E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21804E

Instance id: | SA2_XTD6_EPS/MONITOR/C21804E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21903E

Instance id: | SA2_XTD6_EPS/MONITOR/C21903E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22007E

Instance id: | SA2_XTD6_EPS/MONITOR/C22007E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22104E

Instance id: | SA2_XTD6_EPS/MONITOR/C22104E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22206E

Instance id: | SA2_XTD6_EPS/MONITOR/C22206E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22307E

Instance id: | SA2_XTD6_EPS/MONITOR/C22307E
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

#### HIREX

[add component documentation]

##### ASENS

[add component documentation]

###### CRYSTAL_TEMP

Instance id: | SA2_XTD6_HIREX/ASENS/CRYSTAL_TEMP
Host: | exflcon58n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | Spectrum, Gotthard
Accessible by: | CONTROLS, DA

[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: |

##### AVG

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/AVG/BRAGG
Class id: | ImageAverager
Host: | exflcon172
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | SA2_MDL_BRAGG_SPECTRA, SA2_HIREX_BRAGG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### CRYSTAL

Instance id: | SA2_XTD6_HIREX/AVG/CRYSTAL
Class id: | ImageAverager
Host: | exflcon172
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### DETECTOR

Instance id: | SA2_XTD6_HIREX/AVG/DETECTOR
Class id: | ImageAverager
Host: | exflcon172
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAL

[add component documentation]

###### MASTER

Instance id: | SA2_XTD6_HIREX/CAL/MASTER
Class id: | SlsCalibrator
Host: | sa2-xtd6-hirex-con-1
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/slsCalibrator
Last modified: | 2021-08-06T08:25:04.000+02:00
Created at: | 2017-08-31T14:21:54.000+02:00
Main authors: | Parenti, Hauf, Danilevski
Latest tag: | 1.5.1-2.11.0
Deployment tag: | 1.5.1-2.11.0
Scenes: | SA2_Gotthard, SA2_HIREX_GOTTHARD, SA2_Spectrum, Gotthard_Calibrated-Display, User_Scene, test_scene0, SA2_HIREX_MAIN, SA2_HIREX_Main, Gott_Cal-waterFall_PulseResove-Plot, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- bkg:
    The background on ADC counts.
- cal:
    The calibration constants [keV/counts].
- averagedDisplay:
    Average all the frames in the train and then display.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0. Will not be used if ‘averagedDisplay’ is True.
- useBackgroundFrame:
    Use Frame for Background subtraction
- frameNumber:
    The index of the frame to be used for background subtraction
- errorCount:
    Number of errors.
- reset:
    Reset error count.

Release History
1.5.1-2.11.0

Created: | 2021-08-04T16:24:38.000+02:00
Author: | Alessandro Silenzi
Notes: | revert change in schema types.

1.5.0-2.11.0

Created: | 2021-07-26T17:39:35.000+02:00
Author: | Alessandro Silenzi
Notes: | FIX: output channel data matches the type in the schema. Schema changed properties VECTOR_FLOAT -> VECTOR_DOUBLE

1.4.1-2.10.0

Created: | 2020-11-24T12:14:02.000+01:00
Author: | Andrea Parenti
Notes: | Summary: added version info

1.4.0-2.5.1

Created: | 2019-08-08T15:22:44.000+02:00
Author: | Cyril Danilevski
Notes: | Fix forwarding the data trainId

1.3.1-2.4.0

Created: | 2019-04-08T14:31:43.000+02:00
Author: | Wajid Ehsan
Notes: | Check on Length of array

1.3.0-2.4.0

Created: | 2019-04-02T12:01:40.000+02:00
Author: | Wajid Ehsan
Notes: | Possibility to use the frame as background subtraction

1.2.0-2.3.1

Created: | 2019-02-26T13:58:56.000+01:00
Author: | Wajid Ehsan
Notes: | Changed NDARRAY to IMAGE DATA for output channel

1.1.0-2.2.3

Created: | 2018-04-27T10:34:30.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Average all the frames in the train FIX states (NORMAL -> PASSIVE, ACTIVE)

1.0.2-2.2.1

Created: | 2018-01-17T14:50:05.000+01:00
Author: | Andrea Parenti
Notes: | Add frameToDisplay property - to select which frame from the train shall be displayed

1.0.1-2.1.18

Created: | 2017-11-24T11:28:08.000+01:00
Author: | Andrea Parenti
Notes: | Use numpy magic to calibrate 2-d data with 1-d bkg and constants Add tests and CI configuration

1.0.0-2.1.15

Created: | 2017-09-27T18:29:31.000+02:00
Author: | Andrea Parenti
Notes: |

##### CAM

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/CAM/BRAGG
Class id: | PhotonicScienceCamera
Host: | sa2-xtd6-hirex-con-1
Class documentation:
| PhotonicScienceCamera
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/genicamCameras
Last modified: | 2021-09-06T15:02:56.778+02:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Installed tag: | 3.11.7-2.10.0
Scenes: | SA2_MDL_BRAGG_SPECTRA, SA2_XTD6_HIREX/CAM/BRAGG|scene, SA2_XTD6_HIREX/CAM/BRAGG_CAM|scene, SA2_XTD6_HIREX/CAM/BRAGG_CAM|scene, SA2_XTD6_HIREX/CAM/BRAGG_CAM|scene, SA2_XTD6_HIREX/CAM/BRAGG_CAM|scene, SA2_BRAGG-Cam-BigScren, BRAGG_CAM, SA2_Spectrum, SA2_HIREX_BRAGG, User_Scene, SA2_HIREX_MAIN, SA2_HIREX_Main, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T11:38:08.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T10:47:57.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T08:59:05.000+02:00
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T09:25:37.000+01:00
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T13:47:13.000+02:00
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T13:01:03.000+02:00
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T11:54:55.000+02:00
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T09:51:45.000+02:00
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T13:39:16.000+02:00
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T17:15:23.000+02:00
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T09:14:07.000+01:00
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T09:55:42.000+01:00
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T15:02:35.000+01:00
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T16:03:25.000+01:00
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T11:00:51.000+01:00
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T13:43:55.000+01:00
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T13:27:42.000+02:00
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T16:44:29.000+02:00
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T11:53:47.000+01:00
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

###### CRYSTAL

Instance id: | SA2_XTD6_HIREX/CAM/CRYSTAL
Class id: | LimaBaslerCamera
Host: | sa2-xtd6-hirex-con-1
Class documentation:
| LimaBaslerCamera
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | SA2_Crystal-CAM, SA2_Spectrum, SA2_C-cam-BigScreen
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### DETECTOR

Instance id: | SA2_XTD6_HIREX/CAM/DETECTOR
Class id: | LimaBaslerCamera
Host: | sa2-xtd6-hirex-con-1
Class documentation:
| LimaBaslerCamera
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | SA2_Det-Cam-BigScreen
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### SPARE

Instance id: | SA2_XTD6_HIREX/CAM/SPARE
Class id: | PhotonicScienceCamera
Host: | exflcon172
Class documentation:
| PhotonicScienceCamera
Alias: | sa2-xtd6-hirex-con-1
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: |

Warning

Host not accessible by [‘xctrl’]!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T10:38:08.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T09:47:57.000Z
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

##### DAQ

[add component documentation]

###### GOTTHARD_MASTER

Instance id: | SA2_XTD6_HIREX/DAQ/GOTTHARD_MASTER
Class id: | GotthardReceiver
Host: | sa2-xtd6-hirex-con-1
Class documentation:
| GotthardReceiver
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | SA2_Gotthard, SA2_HIREX_GOTTHARD, SA2_Spectrum, Gotthard_Calibrated-Display, User_Scene, SA2_HIREX_Main, SA2_HIREX_HED
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- rxTcpPort:
    Receiver TCP Port
- framesPerTrain:
    How many frames will be sent to DAQ for each train.If more are received from detector, they will be discarded.
- frameRateIn:
    Frame rate - incoming data from detector.
- frameRateOut:
    Frame rate - decoded data to output channels.
- onlineDisplayEnable:
    Enable online display of detector data.
- frameToDisplay:
    The index of the frame to be displayed in the train, starting from 0.

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### DCTRL

[add component documentation]

###### CRYSTAL_CAM

Instance id: | SA2_XTD6_HIREX/DCTRL/CRYSTAL_CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Crystal-CAM
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CRYSTAL_LED

Instance id: | SA2_XTD6_HIREX/DCTRL/CRYSTAL_LED
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Crystal-CAM, SA2_Spectrum
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DETECTOR_CAM

Instance id: | SA2_XTD6_HIREX/DCTRL/DETECTOR_CAM
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Det-Cam-BigScreen
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DET_BRAGG

Instance id: | SA2_XTD6_HIREX/DCTRL/DET_BRAGG
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_BRAGG-Cam-BigScren, SA2_Spectrum, User_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DET_GOT_MASTER

Instance id: | SA2_XTD6_HIREX/DCTRL/DET_GOT_MASTER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Gotthard, SA2_HIREX_GOTTHARD, Gotthard_Calibrated-Display, User_Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### DET_GOT_SLAVE

Instance id: | SA2_XTD6_HIREX/DCTRL/DET_GOT_SLAVE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### IMG_SPARE

Instance id: | SA2_XTD6_HIREX/DCTRL/IMG_SPARE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### DET

[add component documentation]

###### DETECTOR_GOT

Instance id: | SA2_XTD6_HIREX/DET/DETECTOR_GOT
Class id: | GotthardControl
Host: | sa2-xtd6-hirex-con-1
Class documentation:
| GotthardControl
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/karaboDevices/slsDetectors
Last modified: | 2021-09-21T09:48:34.350+02:00
Created at: | 2018-01-15T15:20:05.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 1.9.2-2.11.1
Deployment tag: | 1.9.2-2.11.1
Scenes: | SA2_Gotthard, SA2_HIREX_GOTTHARD, SA2_Spectrum, Gotthard_Calibrated-Display, User_Scene, SA2_HIREX_MAIN, SA2_HIREX_Main, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Starts acquisition
- stop:
    Stops acquisition
- reset:
    Resets the device in case of an error
- detectorHostName:
    Detector Host Name
- detectorIp:
    Detector IP. Must be on the same subnet as the receiver.
- detectorHostPort:
    Detector Host Port. Will use 1952 if left empty.
- detectorHostStopPort:
    Detector Host Stop Port. Will use 1953 if left empty.
- rxHostname:
    Receiver Hostname
- rxTcpPort:
    Receiver TCP Port
- rxUdpIp:
    Receiver UDP IP
- rxUdpPort:
    Receiver UDP Port
- settings:
    Settings
- online:
    Sets the detector in online (1) or offline (0) mode.
- angDir:
    Sets the angular direction of the detector (1 means channel numberin the same direction as the angular encoder, -1 different direction).
- moveFlag:
    Related to a single controller d. 1 if the detector modules movewith the angular encoder, 0 if they are static (useful for multidetector systems)
- lock:
    lock
- extSig0:
    Ext Sig 0
- vHighVoltageMax:
    Max value allowed for ‘vHighVoltage’. Higher values will be rejected by the device.
- vHighVoltage:
    Sets the DAC value of the high voltage. Options: 0 90 110 120 150 180 200
- master:
    Sets the master of a multi-controller detector to the controller with index i. -1 removes master.
- sync:
    Sets the synchronization mode of the various controller within a detector structure
- badChannels:
    Sets the bad channel filename. Bad channels will be omitted in the .dat file. Use ‘none’ to unset.
- angConv:
    Sets the file with the coefficients for angular conversion. Use ‘none’ to disable angular conversion.
- globalOff:
    Sets the offset of the beamline i.e. angular position of channel0 when angular encoder at 0.
- binSize:
    Sets the size of the angular bins for angular conversion.
- threaded:
    Avoid changing it. Sets if the data are written to disk in parallel with the acquisition (1) or after the acquisition (0).
- detectorDeveloper:
    Detector Developer. (useful to define subset of working functions)
- flatFieldCorrectionFile:
    Flat field corrections file name. Use ‘none’ to disable corrections.
- positions:
    Positions for the acquisition. Usage: n pos1 pos2 … posn
- maximumDetectorSize:
    Maximum detector size
- bitDepth:
    Bit Depth
- exposureTime:
    exposure time value
- exposurePeriod:
    exposure period
- delayAfterTrigger:
    delay after trigger
- numberOfGates:
    Number Of Gates
- numberOfFrames:
    Number Of Frames
- numberOfCycles:
    Number Of Cycles
- timing:
    The timing mode of the detector
- acquisitionTime:
    Acquisition time. Depending on trigger mode, it will set different parameters on thedetector in order to have the acquisition running for the given time.
- triggerPeriod:
    External trigger period. Used together with acquisitionTime to setup detector acquisition parameters.
- detectorNumber:
    Returns the serial number of the module (normally the MAC address).
- detectorVersion:
    Returns the version of the controller firmware.
- softwareVersion:
    Returns the version of the software running on the detector.
- thisVersion:
    Returns the version of the control software which is being used.
- pollingInterval:
    The interval for polling the laser front-end for status.
- tempAdc:
    Returns the ADC temperature.
- tempFpga:
    Returns the FPGA temperature.
- detectorMac:
    Detector MAC. Arbitrary (e.g. 00:aa:bb:cc:dd:ee), but must be not in use in the same subnet.
- rOnline:
    rOnline

Release History
1.9.2-2.11.1

Created: | 2021-05-18T17:36:27.000+02:00
Author: | Dennis Goeries
Notes: | Add interface for sls detectors

1.9.1-2.10.3

Created: | 2021-03-26T10:19:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix header include in Simulation mode.

1.9.0-2.10.1

Created: | 2021-02-08T15:38:14.000+01:00
Author: | Andrea Parenti
Notes: | Summary: update slsDetectorPackage to tag 5.0.1.

1.8.4-2.10.0

Created: | 2021-01-12T11:18:30.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix auto-generated class version.

1.8.3-2.10.0

Created: | 2020-12-02T09:58:03.000+01:00
Author: | Andrea Parenti
Notes: | Summary: fix for boost 1.68 (i.e. Karabo 2.11)

1.8.2-2.10.0

Created: | 2020-11-24T11:31:41.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

1.8.1-2.9.1

Created: | 2020-10-06T16:50:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Fix undefined symbol on Ubuntu 20.04

1.8.0-2.9.1

Created: | 2020-08-05T12:44:04.000+02:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available Add exposureTimer parameter to JF

1.7.3-2.9.1

Created: | 2020-07-29T14:31:06.000+02:00
Author: | xctrl
Notes: | Fix crashes due to (potential) order problem

1.7.2-2.8.3

Created: | 2020-04-30T14:40:13.000+02:00
Author: | Andrea Parenti
Notes: | FIX: use boost async in the receiver simulation.

1.7.1-2.8.1

Created: | 2020-04-29T07:03:42.000+02:00
Author: | Andrea Parenti
Notes: | FIX exposureTime default value

1.7.0-2.8.1

Created: | 2020-04-20T11:29:59.000+02:00
Author: | Andrea Parenti
Notes: | Add Jungfrau simulation Add range for exposureTime and vHighVoltage Replace xdata user with xkarabo (for uploading binary to exflserv05) This tag does not include yet: * Use trainId from frame metadata (not tested yet)

1.7.0rc1-2.7.0

Created: | 2019-12-17T08:56:43.000+01:00
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T10:57:24.000+01:00
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T12:35:18.000+01:00
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T10:35:24.000+02:00
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T15:30:33.000+02:00
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T15:15:22.000+02:00
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T15:28:18.000+02:00
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

##### MDL

[add component documentation]

###### DAQCTRL_1

Instance id: | SA2_XTD6_HIREX/MDL/DAQCTRL_1
Class id: | DaqController
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-11 , sa2-br-sys-con-10 , sa2-br-sys-con-1
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: |

###### FEL_SPECTROMETER

###### KARABACON

Instance id: | SA2_XTD6_HIREX/MDL/KARABACON
Class id: | Karabacon
Host: | sa2-br-sys-con-1
Class documentation:
| Karabacon
Alias: | sa2-br-sys-con-11 , sa2-br-sys-con-10 , sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2021-06-29T10:19:45.000+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Mamchykd, Fabbri, Goeries
Latest tag: | 2.4.3-2.11.1
Deployment tag: | 2.4.3-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!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- use_daq:
    If the scantool should be used without XFEL DAQ, set tofalse. Can only be set before instantiation.
- daqControllerId:
    The deviceId to the daq controller device.
- isConfigured:
    Boolean indicator if the scantool has been configured.
- actualConfiguration:
    String representation of the actual configuration applied for the scan
- activeSources:
    Alias representation of configured data sources
- activeMotors:
    Alias representation of configured motors
- activeTriggers:
    Alias representation of configured triggers
- dataEnv:
    Data Sources
- pipelineWait:
    Set this value to define the pipeline wait time for the data sources to wait for a new value
- pauseEachStep:
    Set to pause on arriving at each motor position
- reset:
    This value is used to reset the plotting
- stream:
    Internal value to signalize streaming while scanning
- isMoving:
    This boolean indicates if the karabacon is in moving state. Required for folding daq data.
- isAcquiring:
    This boolean indicates if the karabacon is acquiringdata. Required for folding daq data.
- acquisitionTime:
    The trigger sources will acquire each step for this period of time. In step scan operation, the Karabacon will wait each step to acquire for this period if configureTriggers is set to True. In continous mode, this value is used to calculate the velocity.
- configureTriggers:
    Set this value to True and the triggers will configure the acquisition time for each step
- configureVelocity:
    Set this value to True to control motor velocity during continuous motion scans. The speed will be calculated from ‘acquisitionTime’.
- availableScenes:
    Provides a scene for the Karabacon. This can be eithera control or plot related scene.
- availableMacros:
    Provides scan macros from the scan device
- output:
    Output Channel for the scan data
- configure:
    Configure the scan environment
- start:
    Start scan with previous applied configuration
- stop:
    Call this slot to stop running scan
- abort:
    Call this slot to stop everything
- pause:
    Call this slot to pause or resume running scan

Release History
2.4.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: |

2.2.0-2.7.0

Created: | 2019-12-04T15:15:33.000Z
Author: | Dennis Goeries
Notes: |

###### WATCHDOG

Instance id: | SA2_XTD6_HIREX/MDL/WATCHDOG
Class id: | GenericActuator
Host: | sa2-xtd6-hirex-con-1
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-05-12T13:52:39.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Haufs, Giovanetti
Latest tag: | 1.10.5-2.10.0
Deployment tag: | 1.10.5-2.10.0
Installed tag: | 1.10.0-2.10.0
Scenes: | SA2_HIREX_Main
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.10.0-2.10.0) does not match tags mentioned in the deployment ([‘1.10.5-2.10.0’])!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doout:
    The slot allows to run assigned action manually
- doyAG:
    The slot allows to run assigned action manually
- doc110:
    The slot allows to run assigned action manually
- dosi110r100:
    The slot allows to run assigned action manually
- dosi11175:
    The slot allows to run assigned action manually
- dosi110r50:
    The slot allows to run assigned action manually

Release History
1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

0.0.3-2.6.1

Created: | 2019-09-26T16:51:16.000Z
Author: | Denys Mamchyk
Notes: | estimator+actuator version to be tested, created from branch

###### CRYSTALRX_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/CRYSTALRX_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- move8000eV:
    Moves the motor to the position marked with this label
- move9000eV:
    Moves the motor to the position marked with this label
- move9300eV:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### CRYSTALUNITX_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/CRYSTALUNITX_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_HIREX_MAIN, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveHED:
    Moves the motor to the position marked with this label
- moveMID:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### CRYSTALUNITY_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/CRYSTALUNITY_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- move8000eV:
    Moves the motor to the position marked with this label
- move9000eV:
    Moves the motor to the position marked with this label
- move9300eV:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### CRYSTALX_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/CRYSTALX_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, SA2_Spectrum, User_Scene, test_scene0, SA2_HIREX_MAIN, SA2_HIREX_Main, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label
- moveC110:
    Moves the motor to the position marked with this label
- moveSi110_r100:
    Moves the motor to the position marked with this label
- moveSi111_75:
    Moves the motor to the position marked with this label
- moveSi110_r50:
    Moves the motor to the position marked with this label
- moveTest:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### DETRX_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/DETRX_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- move8000eV:
    Moves the motor to the position marked with this label
- move9000eV:
    Moves the motor to the position marked with this label
- move9300eV:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### DETX_POSITION

Instance id: | SA2_XTD6_HIREX/MDL/DETX_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_Spectrum, User_Scene, SA2_HIREX_MAIN, SA2_HIREX_Main, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveScreen:
    Moves the motor to the position marked with this label
- moveBragg_Si220:
    Moves the motor to the position marked with this label
- moveGot_Si220:
    Moves the motor to the position marked with this label
- moveBragg_C220:
    Moves the motor to the position marked with this label
- moveGot_C220:
    Moves the motor to the position marked with this label
- moveBragg_Si440:
    Moves the motor to the position marked with this label
- moveGot_Si440:
    Moves the motor to the position marked with this label
- moveBragg_12900eV:
    Moves the motor to the position marked with this label
- moveGot_12900eV:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### FILTER_WHEEL

Instance id: | SA2_XTD6_HIREX/MDL/FILTER_WHEEL
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_Spectrum, SA2_HIREX_MAIN, SA2_HIREX_HED, SA2_HIREX_MAIN0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOUT:
    Moves the motor to the position marked with this label
- movescreen9kev:
    Moves the motor to the position marked with this label
- move9kev_Al1_6:
    Moves the motor to the position marked with this label
- move9kev_Al1_5:
    Moves the motor to the position marked with this label
- move9kev_Al1_3:
    Moves the motor to the position marked with this label
- move9kev_Al1_2:
    Moves the motor to the position marked with this label
- move9kev_Al1_1:
    Moves the motor to the position marked with this label
- move9kev_Al1:
    Moves the motor to the position marked with this label
- move9kev_Al0_8:
    Moves the motor to the position marked with this label
- move9kev_Al0_7:
    Moves the motor to the position marked with this label
- moveCu_MO_foil:
    Moves the motor to the position marked with this label
- moveScreen8_15kev:
    Moves the motor to the position marked with this label
- move8_15kev_Al1_6:
    Moves the motor to the position marked with this label
- move8_15kev_Al1_5:
    Moves the motor to the position marked with this label
- move8_15kev_Al1_3:
    Moves the motor to the position marked with this label
- move8_15kev_Al1_2:
    Moves the motor to the position marked with this label
- move8_15kev_Al1_1:
    Moves the motor to the position marked with this label
- move8_15kev_Al1:
    Moves the motor to the position marked with this label
- move8_15kev_Al0_8:
    Moves the motor to the position marked with this label
- move8_15kev_Al0_7:
    Moves the motor to the position marked with this label
- move8_15kev_Mo:
    Moves the motor to the position marked with this label
- moveScreen9to8keV_Si220:
    Moves the motor to the position marked with this label
- moveSi220_Al1_6:
    Moves the motor to the position marked with this label
- moveSi220_Al1_5:
    Moves the motor to the position marked with this label
- moveSi220_Al1_3:
    Moves the motor to the position marked with this label
- moveSi220_Al1_2:
    Moves the motor to the position marked with this label
- moveSi220_Al1_1:
    Moves the motor to the position marked with this label
- moveSi220_Al1:
    Moves the motor to the position marked with this label
- moveSi220_Al0_8:
    Moves the motor to the position marked with this label
- moveSi220_Al0_7:
    Moves the motor to the position marked with this label
- move7_5keV_C220_screen:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1_6:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1_5:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1_3:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1_2:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1_1:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al1:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al0_8:
    Moves the motor to the position marked with this label
- move7_5keV_C220_Al0_7:
    Moves the motor to the position marked with this label
- move13keV_C440_screen:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1_6:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1_5:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1_3:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1_2:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1_1:
    Moves the motor to the position marked with this label
- move13keV_C440_Al1:
    Moves the motor to the position marked with this label
- move13keV_C440_Al0_8:
    Moves the motor to the position marked with this label
- move13keV_C440_Al0_7:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CRYSTALUNIT_X

###### CRYSTALUNIT_Y

###### CRYSTAL_RX

###### CRYSTAL_X

###### DETECTOR_RX

###### DETECTOR_X

###### SPARE_1

###### FILTER_WHEEL

##### PROC

[add component documentation]

###### BRAGG

Instance id: | SA2_XTD6_HIREX/PROC/BRAGG
Class id: | ImageProcessor
Host: | exflcon172
Class documentation:
| ImageProcessor
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | SA2_Proc_Bragg, SA2_BRAGG-Cam-BigScren
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### CRYSTAL

Instance id: | SA2_XTD6_HIREX/PROC/CRYSTAL
Class id: | ImageProcessor
Host: | exflcon172
Class documentation:
| ImageProcessor
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### DETECTOR

Instance id: | SA2_XTD6_HIREX/PROC/DETECTOR
Class id: | ImageProcessor
Host: | exflcon172
Class documentation:
| ImageProcessor
Alias: | sa2-xtd6-hirex-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### TSYS

[add component documentation]

###### BRAGG_TRIGGER

Instance id: | SA2_XTD6_HIREX/TSYS/BRAGG_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### CRYSTAL_CAM_TRIGGER

Instance id: | SA2_XTD6_HIREX/TSYS/CRYSTAL_CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### DET_CAM_TRIGGER

Instance id: | SA2_XTD6_HIREX/TSYS/DET_CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### GOTTHARD_TRIGGER

Instance id: | SA2_XTD6_HIREX/TSYS/GOTTHARD_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### SPARE_CAM_TRIGGER

Instance id: | SA2_XTD6_HIREX/TSYS/SPARE_CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

##### ZEROMQ

[add component documentation]

###### CAM

Instance id: | SA2_XTD6_HIREX/ZEROMQ/CAM
Host: | exflonc27
Alias: | sa2-br-kc-comp-3 , la2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-03-09T17:36:17.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.0.1-2.7.1
Deployment tag: | 3.0.1-2.7.1
Installed tag: | 3.0.0-2.7.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (3.0.0-2.7.1) does not match tags mentioned in the deployment ([‘3.0.1-2.7.1’])!

[add instance documentation]

Release History
3.0.1-2.7.1

Created: | 2020-03-09T16:39:08.000Z
Author: | Thomas Michelat
Notes: | FIX for device crashing if a incoming data source name contains a dot.

3.0.0-2.7.1

Created: | 2020-02-17T18:11:31.000Z
Author: | Thomas Michelat
Notes: |

2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

###### GOTTHARD

Instance id: | SA2_XTD6_HIREX/ZEROMQ/GOTTHARD
Class id: | PipeToZeroMQ
Host: | exflonc27
Alias: | la2-br-kc-comp-3 , sa2-br-kc-comp-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

##### SWITCH

[add component documentation]

###### S1

Instance id: | SA2_XTD6_HIREX/SWITCH/S1
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S2

Instance id: | SA2_XTD6_HIREX/SWITCH/S2
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S3

Instance id: | SA2_XTD6_HIREX/SWITCH/S3
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S4

Instance id: | SA2_XTD6_HIREX/SWITCH/S4
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S5

Instance id: | SA2_XTD6_HIREX/SWITCH/S5
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### S6

Instance id: | SA2_XTD6_HIREX/SWITCH/S6
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VDCTRL

[add component documentation]

###### HIREX_MOVING

Instance id: | SA2_XTD6_HIREX/VDCTRL/HIREX_MOVING
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### VALVE

[add component documentation]

###### FAST_SHUTTER_GOT

Instance id: | SA2_XTD6_HIREX/VALVE/FAST_SHUTTER_GOT
Class id: | BeckhoffValve
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Gotthard, SA2_Spectrum, SA2_HIREX_MAIN
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

#### IMGPII45-1

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | SA2_XTD6_IMGPII45-1_AVG, Beam_Imagers, POP-in_1_avg_large, SA2_XTD6_IMGPII45-1_AVG, SA2_XTD6_IMGPII45-1_MAIN_New, SA2_XTD6_IMGPII45-1_Spot_Size
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-7
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Scenes: | SA2_XTD6_IMGPII45-1_AVG, SA2_MAIN, Beam_Imagers, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_MAIN0, POP-in_1_large, SA2_MAIN, SA2_MAIN, SA2_XTD6_IMGPII45-1/CAM/BEAMVIEW, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_AVG, SA2_XTD6_IMGPII45-1_MAIN_New, SA2_XTD6_IMGPII45-1/CAM/BEAMVIEW, SA2_MAIN_BKR-wallpaper, SA2_XTD6_IMGPII45-1_Spot_Size
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | SA2_XTD6_IMGPII45-1/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | SA2_XTD6_IMGPII45-1/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Scenes: | Beam_Imagers, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_MAIN0, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_MAIN_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### SCREEN_POSITION

Instance id: | SA2_XTD6_IMGPII45-1/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Scenes: | Beam_Imagers, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_MAIN0, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1/MDL/SCREEN_POSITION|scene, SA2_XTD6_IMGPII45-1_MAIN_New, SA2_XTD6_IMGPII45-1/MDL/SCREEN_POSITION|scene, HED_BEAMLINE_STATUS/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### SCREEN

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-1/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon72n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Scenes: | SA2_XTD6_IMGPII45-1_AVG, test XGMvsIMGPII45-1, SA2_XTD6_IMGPII45-1_fitted_size, Beam_POSITION, SA2_XTD6_IMGPII45-1_MAIN, SA2_XTD6_IMGPII45-1_AVG, SA2_XTD6_IMGPII45-1_MAIN_New, SA2_XTD6_IMGPII45-1_Spot_Size
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | SA2_XTD6_IMGPII45-1/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-1, SA2_MAIN_copy
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_BEAMLINE_STATUS/Shutdown, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | SA2_XTD6_IMGPII45-1/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### IMGPII45-2

[add component documentation]

##### AVG

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/AVG/BEAMVIEW
Class id: | ImageAverager
Host: | exflcon72n0
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | POP-in_2_avg_large, SA2_XTD6_IMGPII45-2_Spot_Size, SA2_XTD6_IMGPII45-2_AVG, SA2_XTD6_IMGPII45-2_MAIN_New
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-7
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-7
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Scenes: | SA2_XTD6_IMGPII45-2, SA2_XTD6_IMGPII45-2_broken, SA2_MAIN, Beam_Imagers, POP-in_2_large, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2/CAM/BEAMVIEW, SA2_MAIN, SA2_MAIN, SA2_XTD6_IMGPII45-2/CAM/BEAMVIEW, SA2_XTD6_IMGPII45-2_Spot_Size, SA2_XTD6_IMGPII45-2_AVG, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp_CK, SA2_XTD6_IMGPII45-2_AVG_MAIN, SA2_MAIN_BKR-wallpaper, SA2_XTD6_IMGPII45-2_MAIN0, SA2_XTD6_IMGPII45-2_MAIN_New, MID_XTD6_Imagers
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | SA2_XTD6_IMGPII45-2/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | SA2_XTD6_IMGPII45-2/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Scenes: | Beam_Imagers, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp_CK, SA2_XTD6_IMGPII45-2_AVG_MAIN, SA2_XTD6_IMGPII45-2_MAIN0, SA2_XTD6_IMGPII45-2_MAIN_New
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM2_POWER

Instance id: | SA2_XTD6_IMGPII45-2/DCTRL/CAM2_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED2_POWER

Instance id: | SA2_XTD6_IMGPII45-2/DCTRL/LED2_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM2_TRIGGER

##### MDL

[add component documentation]

###### SCREEN_POSITION

Instance id: | SA2_XTD6_IMGPII45-2/MDL/SCREEN_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Scenes: | SA2_XTD6_IMGPII45-2, SA2_XTD6_IMGPII45-2_broken, Beam_Imagers, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2_MAIN, SA2_XTD6_IMGPII45-2/MDL/SCREEN_POSITION|scene, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp_CK, SA2_XTD6_IMGPII45-2_AVG_MAIN, SA2_XTD6_IMGPII45-2_MAIN0, SA2_XTD6_IMGPII45-2_MAIN_New, SA2_XTD6_IMGPII45-2/MDL/SCREEN_POSITION|scene, HED_BEAMLINE_STATUS/Shutdown
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveYAG:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### SCREEN

###### NAVITAR_FOCUS

###### NAVITAR_ZOOM

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_IMGPII45-2/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon72n0
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-stage
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Scenes: | SA2_XTD6_IMGPII45-2_MAIN, Beam_POSITION, SA2_XTD6_IMGPII45-2_Spot_Size, SA2_XTD6_IMGPII45-2_AVG, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp_CK, SA2_XTD6_IMGPII45-2_AVG_MAIN, SA2_XTD6_IMGPII45-2_MAIN_New, MID_XTD6_Imagers, SA2_XTD6_IMGPII45-2_AVG_MAIN_temp1_CK
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### SCREEN_OUT

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/SCREEN_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_IMGPII45-2, SA2_MAIN_copy
Scenes: | SA2_Watchdog_overview_screens, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_MAIN, SA2_MAIN_BKR-wallpaper, HED_BEAMLINE_STATUS/Shutdown, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_SYNC

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/CAM_SYNC
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FOCUS_FAR

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/FOCUS_FAR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### FOCUS_NEAR

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/FOCUS_NEAR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ZOOM_FAR

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/ZOOM_FAR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### ZOOM_NEAR

Instance id: | SA2_XTD6_IMGPII45-2/SWITCH/ZOOM_NEAR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### TRIGGER

Instance id: | SA2_XTD6_IMGPII45-2/TSYS/TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MCP

[add component documentation]

##### ADC

[add component documentation]

###### 1

Instance id: | SA2_XTD6_MCP/ADC/1
Class id: | FastAdc
Host: | sa2-xtd6-sys-utc-r27
Class documentation:
| FastAdc
Alias: | sa2-xtd6-sys-utc-r27-mch , sa2-xtd6-sys-utc-r27
Git repo: | https://git.xfel.eu/karaboDevices/fastAdc
Last modified: | 2021-10-05T11:19:39.976+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Hauf, Mamchykd, Fernands
Latest tag: | 2.8.6-2.11.1
Deployment tag: | 2.8.6-2.11.1
Installed tag: | 2.8.6-2.11.1
Scenes: | Main-Scene-MCP2, test, Main-Scene-MCP-PD, Main-Scene-MCP1, Main-Scene-MCP3, All ADC channels, testMeanPeak, XGM-vs-MCP
Accessible by: | CONTROLS, CTRL, babies, cascella, mramilli, samartse, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Fast ADC

The `FastADC` device is documented in fastadc:welcome

Trouble Shooting

- If the device instantiate and goes immediately into error, even after server restarts,

> check the configuration of the Map directory parameter. For most crates it should be pointing to /home/xctrl/maps. If the problem persists, likely the driver was not loaded. If you have xctrl access to the crate, check if the Device file is present. If it is not or you do not have access, call EEE FPGA OCD.

- If you see flat noise in the raw data, stop the acquisition, click the ADC Reset button and start acquisition. If this doesn’t help, try restarting the device server (right click in the project, or topology view). If further help is needed, contact EEE FPGA OCD (9-8041).
- Make sure you have enablePeakComputation checked for those channels where you need it
- If you are outputting raw data and have incomplete data, or the device crashes recurrently, check the number of samples you are using. Known working sample numbers are ~800k samples on each channel.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- reset:
    Resets the device in case of an error
- trigger:
    Sends a software trigger to the hardware (always possible, independent of chosen trigger mode)
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- digitizerFrequency:
    ADC sampling frequency.
- adcRange:
    Voltage range (peak to peak) of ADC chips.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- rawFrequency:
    Raw data sampling frequency.
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.6-2.11.1

Created: | 2021-07-05T18:16:26.000+02:00
Author: | Wajid Ehsan
Notes: | Update tag for utca configuration

2.8.5-2.11.1

Created: | 2021-07-05T14:39:35.000+02:00
Author: | Wajid Ehsan
Notes: | Add Raw frequency parameter.

2.8.4-2.11.1

Created: | 2021-07-05T13:49:35.000+02:00
Author: | Wajid Ehsan
Notes: | update iibus tag (Fixed bug with 32 bit signed values_

2.8.3-2.11.1

Created: | 2021-06-25T13:42:45.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T19:42:44.000+02:00
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T18:00:03.000+02:00
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T16:21:15.000+02:00
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T11:37:55.000+02:00
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T18:15:10.000+02:00
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T09:25:59.000+02:00
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T14:52:10.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T12:52:36.000+01:00
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T14:31:13.000+01:00
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T17:43:01.000+02:00
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T16:25:10.000+02:00
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T10:12:17.000+02:00
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T19:36:37.000+02:00
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T13:38:00.000+01:00
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T13:27:17.000+01:00
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T09:56:32.000+02:00
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_MCP/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-10
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-10
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | SA2_XTD6_MCP/CAM/BEAMVIEW, Main-Scene-BOS-MCP, Test, SA2_XTD6_MCP/CAM/BEAMVIEW|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER

Instance id: | SA2_XTD6_MCP/DCTRL/CAM_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### INHIBIT

Instance id: | SA2_XTD6_MCP/DCTRL/INHIBIT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### LED_POWER

Instance id: | SA2_XTD6_MCP/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Main-Scene-BOS-MCP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### UVLAMP

Instance id: | SA2_XTD6_MCP/DCTRL/UVLAMP
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Main-Scene-MCP2, Main-Scene-MCP-PD, SA2_XTD6_MCP-DCTRL-UVLAMP, Main-Scene-MCP1, Main-Scene-MCP3, Main-Scene-BOS-MCP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MCPS

[add component documentation]

###### MPOD

Instance id: | SA2_XTD6_MCP/MCPS/MPOD
Class id: | Mpod
Host: | sa2-br-sys-con-1
Class documentation:
| Mpod
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- loadChannelConfigs:
    Controls whether channel a configuration file is loaded on device instantiation, which file type is specified in key startupConfigType. If an error occurs processing the file then the device goes to ERROR.
- startupConfigType:
    Defines whether last saved or approved configuration is loaded on instantiation
- applyInProgress:
    Load configs in progress if True
- loadedChannelConfigFile:
    Last loaded channel config filename
- appliedChannelConfigType:
    Last applied channel config filename
- slotSaveConfiguration:
    Write the current configuration to store
- slotApplyConfiguration:
    Applies last saved configuration from store to h/w and s/w
- slotApplyApprovedConfiguration:
    Applies expert approved configuration from store. This is for the case that if applying the last saved configuration is unworkable, then applying the approved configuartion may work. If it does work, then save the configuration so that it is applied on startup
- hostname:
    Host name or IP address for communication module in MPOD crate
- type:
    The configuration type determines whichproperties are exposed STANDARD = STANDARD list of channel properties, AGIPD = AGIPD detector channel properties, DSSC = DSSC detector channel properties, PNCCD = PNCCD channel properties, DEFAULT = default channel properties, ALL = ALL channel properties, VME = VME crate property list, BARE_MIN = minimum list of properties for tests
- updatePolicy:
    Controls when polled property values are written (updated) to the control system. ALL_NOCOND_EVERYPOLL - all updated every poll; ALL_CHANGING_EVERYPOLL - all updated if any channel changing every poll; IV_NOCOND_EVERYPOLL - channel I,V and state every poll
- configuration:
    Container for configuration properties
- setCmdErrors:
    Count of snmp set command errors
- setCmdFailed:
    Count of snmp set command failures
- getCmdErrors:
    Count of snmp get command errors
- walkCmdErrors:
    Count of snmp walk command errors
- pollResultSkips:
    Count of poll result set skipped due to concurrent command received
- pollSetCount:
    Count of sets in single hash sent to control system at end of last poll
- slotEnable:
    When enabled crate output channels can be switched on/off
- slotDisable:
    When disabled crate output channels cannot be switched on
- slotReset:
    Reset device
- slotClearInterlocks:
    Clear all latched interlocks
- autoRearm:
    ISEG HV boards latch fired interlocks, WIENER LV boards do not. To align HV to LV behaviour set this property True. The rearm is performed after the next poll
- slotClearTrips:
    Clear all trips
- slotInjectError:
    Force to ERROR
- pollTimeTaken:
    Seconds required to complete snmp commands and result handling of the last polling loop excluding polling interval wait time
- pollCount:
    Poll counter, resets to zero on Enable
- pollChannelSummary:
    Last poll channel status
- boards:
    The node represents all MPOD boards
- channels:
    Container populated with channels discovered in the crate.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

##### MDL

[add component documentation]

###### ADC_BUNCH

Instance id: | SA2_XTD6_MCP/MDL/ADC_BUNCH
Class id: | AdcBunchPattern
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/pulsePatternDecoder
Last modified: | 2021-09-10T16:40:35.942+02:00
Created at: | 2018-11-27T17:48:42.000+01:00
Main authors: | Haufs, Mercadier, Ehsan
Latest tag: | 2.0.5-2.11.0
Deployment tag: | 2.0.5-2.11.0
Installed tag: | 2.0.5-2.11.0
Scenes: | Main-Scene-MCP2, Main-Scene-MCP-PD, Main-Scene-MCP1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- beamline:
    Which SASE is being scanned
- patternDecoder:
    PulsePattern Decoder deviceId
- adc:
    fastADC deviceId
- tuningDelay:
    Fixed value (number of samples), tuned by beamline scientist
- pulseInterval:
    Interval between two consecutive pulses
- pulseDelay:
    Number of samples between trigger and first pulse
- rawDelay:
    Time delay between trigger and start of raw data acquisition.
- pulsePeriod:
    Number of samples between pulses

Release History
2.0.5-2.11.0

Created: | 2021-07-23T15:24:27.000+02:00
Author: | Alessandro Silenzi
Notes: | no change in schema

2.0.4-2.10.4

Created: | 2021-05-17T19:36:32.000+02:00
Author: | Alessandro Silenzi
Notes: | Added Laser decoding to the PulsePatternDecoder

2.0.3-2.10.0

Created: | 2020-11-24T13:00:46.000+01:00
Author: | Wajid Ehsan
Notes: | Update Version Info

2.0.2-2.9.6-log-timestamps

Created: | 2020-09-24T14:48:03.000+02:00
Author: | Gabriele Giovanetti
Notes: |

2.0.2-2.9.6

Created: | 2020-09-16T15:50:05.000+02:00
Author: | Gabriele Giovanetti
Notes: | FIX: prevent unwanted task in karabo 2.9 note: can be used also with other karabo versions

2.0.1-2.9.6

Created: | 2020-09-11T14:56:10.000+02:00
Author: | Gabriele Giovanetti
Notes: | Prevent timestamp jumping backwards

2.0.0-2.9.4-hotfix@SPB

Created: | 2020-09-11T14:11:25.000+02:00
Author: | Gabriele Giovanetti
Notes: | Temporary hotfix: bunchpattern table timestamp propagation leads to wrong data in DAQ

2.0.0-2.9.4

Created: | 2020-08-17T14:53:49.000+02:00
Author: | Steffen Hauf
Notes: | Read the patternTable via an input channel

1.5.0-2.7.0-hotfix

Created: | 2020-07-23T18:04:33.000+02:00
Author: | degon
Notes: | hotfix: fire start slot twice for digitizer

1.5.0-2.7.0

Created: | 2020-03-03T12:36:56.000+01:00
Author: | Wajid Ehsan
Notes: | Integration of new device class which facilitates the integration of Bunch pattern integration into Digitizer

1.4.1-2.6.1

Created: | 2019-11-12T14:57:06.000+01:00
Author: | Denys Mamchyk
Notes: | minor fix for updating the status on error

1.4.0-2.6.1

Created: | 2019-10-04T14:14:33.000+00:00
Author: | Valerii Bondar
Notes: | “Proper” deployment tag from ‘master’ branch. Includes OperationChangeNotifier with no prints.

1.4.0-2.6.1-test

Created: | 2019-10-02T18:48:32.000+02:00
Author: | Valerii Bondar
Notes: | Left by Valerii in his rush to the airport, but we need it now. Print statement must be removed

1.3.2-2.5.0-Notifier

Created: | 2019-09-23T13:53:03.000+02:00
Author: | Valerii Bondar
Notes: | This tag is only for tests of OperationChangeNotifier prototype in MID topic. For production deployment use ‘proper’ tag recommended. This tag should be installed only afterwards (with install_device_active.yml) and decommissioned after tests.

1.3.2-2.5.0

Created: | 2019-08-07T17:00:04.000+02:00
Author: | Denys Mamchyk
Notes: | update for rawDelay calculation

1.3.1-2.5.0

Created: | 2019-08-02T17:21:20.000+02:00
Author: | Wajid Ehsan
Notes: | Set pulse Delay

1.3.0-2.5.0

Created: | 2019-07-30T13:43:21.000+02:00
Author: | Cammille Carinan
Notes: | Integration of bunch pattern setting into fastadc device.

1.2.0-2.3.0

Created: | 2019-03-13T19:08:04.000+01:00
Author: | Alessandro Silenzi
Notes: | Using the euxfel_bunch_pattern package

1.1.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | added MainDump node

1.0.0-2.3.4

Created: | 2019-02-12T18:10:16.000+01:00
Author: | Alessandro Silenzi
Notes: | Main dump is included in the decoding

###### CAM_POSITION

Instance id: | SA2_XTD6_MCP/MDL/CAM_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### VOLTAGE_FEEDBACK

Instance id: | SA2_XTD6_MCP/MDL/VOLTAGE_FEEDBACK
Class id: | GenericActuator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genericWatchdog
Last modified: | 2021-06-30T17:55:32.000+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Hauf, Mamchykd, Haufs
Latest tag: | 1.10.6-2.11.1
Deployment tag: | 1.10.6-2.11.1
Scenes: | testMeanPeak
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
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)
- doreduceVoltage1:
    The slot allows to run assigned action manually
- doreduceVoltage2:
    The slot allows to run assigned action manually
- doreduceVoltage3:
    The slot allows to run assigned action manually
- doincreaseVoltage1:
    The slot allows to run assigned action manually
- doincreaseVoltage2:
    The slot allows to run assigned action manually
- doincreaseVoltage3:
    The slot allows to run assigned action manually

Release History
1.10.6-2.11.1

Created: | 2021-06-24T12:35:44.000Z
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T16:13:16.000Z
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T01:59:10.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-20T23:35:08.000Z
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T12:49:39.000Z
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T11:17:25.000Z
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T13:49:04.000Z
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T10:22:09.000Z
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T18:08:02.000Z
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T18:32:21.000Z
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T09:00:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T10:20:15.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T16:58:46.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T13:45:29.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T14:22:28.000Z
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T00:22:14.000Z
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T10:21:19.000Z
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

1.0.0-2.6.1-test

Created: | 2019-10-17T14:27:25.000Z
Author: | Denys Mamchyk
Notes: | testing branch

0.0.4-2.6.1

Created: | 2019-10-14T14:21:06.000Z
Author: | Denys Mamchyk
Notes: | For testing, tagged from branch. Cancel command refactored

###### X1_POSITION

Instance id: | SA2_XTD6_MCP/MDL/X1_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_XTD6_MCP/MDL/X1_POSITION|scene, SA2_XTD6_MCP/MDL/X1_POSITION|scene, Main-Scene-MCP2, Main-Scene-MCP-PD, Main-Scene-MCP1, MAIN—MCP-Selector-Scene, SA2_XTD6_MCP/MDL/X1_POSITION|scene, SA2_XTD6_MCP/MDL/X1_POSITION|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- movePD_SR:
    Moves the motor to the position marked with this label
- moveMCP2_SR:
    Moves the motor to the position marked with this label
- movePARASITIC:
    Moves the motor to the position marked with this label
- movePD_FEL:
    Moves the motor to the position marked with this label
- moveMCP1_SR:
    Moves the motor to the position marked with this label
- moveMCP2_FEL:
    Moves the motor to the position marked with this label
- moveMCP1_FEL:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### X2_POSITION

Instance id: | SA2_XTD6_MCP/MDL/X2_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_XTD6_MCP/MDL/X2_POSITION|scene, SA2_XTD6_MCP/MDL/X2_POSITION|scene, Main-Scene-MCP3, Main-Scene-BOS-MCP, MAIN—MCP-Selector-Scene, test, SA2_XTD6_MCP/MDL/X2_POSITION|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveMCP3_SR:
    Moves the motor to the position marked with this label
- movePARASITIC:
    Moves the motor to the position marked with this label
- moveBOS_SR:
    Moves the motor to the position marked with this label
- moveMCP3_FEL:
    Moves the motor to the position marked with this label
- moveBOS_FEL:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### Y1_POSITION

Instance id: | SA2_XTD6_MCP/MDL/Y1_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Scenes: | SA2_XTD6_MCP/MDL/Y1_POSITION|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveDefault:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

###### Y2_POSITION

Instance id: | SA2_XTD6_MCP/MDL/Y2_POSITION
Class id: | BeamImagingUnit
Host: | sa2-br-sys-con-5
Alias: | sa2-br-sys-con-5
Git repo: | https://git.xfel.eu/karaboDevices/beamImagingUnit
Last modified: | 2021-08-25T13:15:55.708+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Ehsan, Ehsanw
Latest tag: | 1.3.8-2.11.0
Deployment tag: | 1.3.8-2.11.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveOut:
    Moves the motor to the position marked with this label
- moveDefault:
    Moves the motor to the position marked with this label

Release History
1.3.8-2.11.0

Created: | 2021-08-25T13:16:37.000+02:00
Author: | Wajid Ehsan
Notes: | Change requestScene slot

1.3.7-2.11.0

Created: | 2021-05-20T17:44:30.000+02:00
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T14:56:25.000+01:00
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T16:53:29.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T14:20:52.000+02:00
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T14:34:58.000+01:00
Author: | Denys Mamchyk
Notes: | temporary branch with double move fix applied for endless filter motors. For other motors use 1.3.3-2.2.4 tag, created from master

1.3.3-2.2.4

Created: | 2018-12-17T10:09:48.000+01:00
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T17:32:10.000+02:00
Author: | Denys Mamchyk
Notes: | working version with double move fix applied. Once the AE fixes the bug, create a tag from master

1.3.1-2.2.4

Created: | 2018-09-12T13:49:47.000+02:00
Author: | Denys Mamchyk
Notes: | temporary fix for #29554 (endless motors stops at 0). will be solved on PLC side later @Jan Tolkiehn

1.3.0-2.2.4

Created: | 2018-06-08T14:01:39.000+02:00
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T16:31:17.000+02:00
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T10:05:56.000+01:00
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T17:39:08.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T15:36:41.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T14:40:08.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T15:16:34.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T18:03:35.000+02:00
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T17:55:03.000+02:00
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CAM

###### X1

###### X2

###### Y1

###### Y2

##### PROC

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_MCP/PROC/BEAMVIEW
Class id: | ImageProcessor
Host: | exflcon178
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### PSC

[add component documentation]

###### BOS_MCP

Instance id: | SA2_XTD6_MCP/PSC/BOS_MCP
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | SA2_XTD6_MCP/PSC/BOS_MCP, Main-Scene-BOS-MCP, MAIN—MCP-Selector-Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### BOS_PHOSPHOR_SCREEN

Instance id: | SA2_XTD6_MCP/PSC/BOS_PHOSPHOR_SCREEN
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | SA2_XTD6_MCP/PSC/BOS_PHOSPHOR_SCREEN, Main-Scene-BOS-MCP, MAIN—MCP-Selector-Scene, Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### MCP1

Instance id: | SA2_XTD6_MCP/PSC/MCP1
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | SA2_XTD6_MCP/PSC/MCP1, Main-Scene-MCP1, MAIN—MCP-Selector-Scene, Test
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### MCP2

Instance id: | SA2_XTD6_MCP/PSC/MCP2
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | Main-Scene-MCP2, SA2_XTD6_MCP/PSC/MCP2, MAIN—MCP-Selector-Scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### MCP3

Instance id: | SA2_XTD6_MCP/PSC/MCP3
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | SA2_XTD6_MCP/PSC/MCP3, Main-Scene-MCP3, MAIN—MCP-Selector-Scene, SA2_XTD6_MCP-PSC-MCP3-template
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

###### PHOTODIODE

Instance id: | SA2_XTD6_MCP/PSC/PHOTODIODE
Class id: | MpodAveragingHVGroup
Host: | sa2-br-sys-con-1
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/mpod
Last modified: | 2021-05-25T10:34:34.000+02:00
Created at: | 2016-11-16T16:13:53.000+01:00
Main authors: | Hauf, Haufs, Parenti
Latest tag: | 5.2.3-2.10.4
Deployment tag: | 5.2.3-2.10.4
Scenes: | SA2_XTD6_MCP/PSC/PHOTODIODE, Main-Scene-MCP-PD, MAIN—MCP-Selector-Scene, SA2_XTD6_MCP/PSC/TEMPLATE
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

MPOD Documentation

- Troubleshooting
- General mpod package documentation

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- devices:
    Devices to act upon
- group:
    Group of nodes to look for tags
- tags:
    Apply changes to channels which have all tags
- trumplist:
    The state trumping order
- leaf:
    The name of the property to set on the device
- value:
    The value to set the property to
- aggregate_state:
    The most significant state of all dependent devices
- execute:
    Set all the values with the proper tag in the devices
- voltage:
    Voltage value to set
- current:
    This current should not be exceed.
- supervisionBehavior:
    A bit field packed into an integer which defines the behavior of the output channel / power supply after failures.
- switch:
    Output switch: off (0), on (1), resetEmergencyOff (2), setEmergencyOff (3), clearEvents (10)
- availableScenes:
    Scenes available for Mpod
- tags_state:
    The most significant state of all dependent tags
- tags_voltage:
    The mean value of all voltages belonging to tags.
- tags_current:
    The mean value of all currents belonging to tags.
- voltageRampRate:
    The rate assigned for voltage ramp up/down in V/sec on the channel.

Release History
5.2.3-2.10.4

Created: | 2021-05-20T19:32:08.000+02:00
Author: | Sergey Esenov
Notes: | Async await / yield from

5.2.2-2.10.0

Created: | 2020-11-24T08:19:01.000+01:00
Author: | Steffen Hauf
Notes: |

5.2.1-2.7.0

Created: | 2019-12-18T16:53:16.000+01:00
Author: | Andrea Parenti
Notes: |

5.2.0-2.6.1

Created: | 2019-09-18T16:56:55.000+02:00
Author: | Christopher Youngman
Notes: | Adds ‘approved’ configuration file feature, which cannot be overwritten by a user (non-expert) saved configuration. Also fixes error due to updateSchema() framework change. For change log details see doc/source/Mpod_version_tags.rst

5.1.4-2.5.0

Created: | 2019-08-02T08:47:34.000+02:00
Author: | Christopher Youngman
Notes: | Add VME to existing types (DSSC, PNCCD, AGIPD…) to allow WIENER VME crate to be operated as it uses the same MIB definitions.

5.1.3-2.4.0

Created: | 2019-07-09T10:58:57.000+02:00
Author: | Astrid Muennich
Notes: | Extended FakeMpod capability to read in an xml config file

5.1.2-2.5.0

Created: | 2019-07-02T12:03:13.000+02:00
Author: | Christopher Youngman
Notes: | Using this version is recommended, but I’d suggest that that you contact CY to ensure that systems upgrading from tags < 5.1.1 are correctly configured.

5.1.1-2.4.0

Created: | 2019-06-12T13:50:05.000+02:00
Author: | Christopher Youngman
Notes: | This tag issued to formalize the fact that the tagged branch 5.1.1-2.4.0-FixBitRegulationEnum has been merged into master.

5.1.1-2.4.0-FixBitRegulationEnum

Created: | 2019-05-23T11:54:22.000+02:00
Author: | Christopher Youngman
Notes: | Fixes regulation bit enum to what is required by testing on mpod f/w 4152 and 3496. The statement from Wiener is that this issue (change of documentation in the MIB file) has no f/w revelance.

5.1.0-2.4.0

Created: | 2019-04-25T23:19:39.000+02:00
Author: | Christopher Youngman
Notes: | Update field tested against initial DSSC installation in SCS, they are not through with their work and may still give feedback. Not tested with AGIPD.

5.0.2-2.3.4-DSSC-Hotfix

Created: | 2019-04-25T08:14:37.000+02:00
Author: | Christopher Youngman
Notes: | tags the branch which will be merged soon. This commit is the one working in SCS DSSC installation.

5.0.2.1-2.3.4hotfix_bulkset

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | Tag off fix/bulk_sets_missing_ids to allow this fix to be installed at SPB

4.1.2-2.2.4_col-id-hotfix

Created: | 2019-04-03T08:35:04.000+02:00
Author: | Steffen Hauf
Notes: | This is what is running at SPB as from 8.4.2019

5.0.2-2.3.4

Created: | 2019-03-29T09:58:18.000+01:00
Author: | Christopher Youngman
Notes: | This tag is for tests to be done by SQS and should not be used elsewhere

5.0.1-2.3.4

Created: | 2019-03-28T09:43:24.000+01:00
Author: | Christopher Youngman
Notes: | This tagged version will be tested in SQS - it should not be deployed elsewhere.

5.0.0-2.3.4

Created: | 2019-02-25T07:45:03.000+01:00
Author: | Christopher Youngman
Notes: | Significant changes have been made. Many at the request of SQS who have now migrated from the test branch to this tag version for live work - other users should stay with lower tags for the time being.

4.1.2-2.2.4

Created: | 2019-02-01T12:58:01.000+01:00
Author: | Steffen Hauf
Notes: |

4.1.1-2.2.4

Created: | 2018-11-09T15:25:51.000+01:00
Author: | Christopher Youngman
Notes: | Added crateNode.ignoreFlags boolean to control check of crate control register bits action. If False goto ERROR, if True continue startup.

4.1.0-2.2.4

Created: | 2018-10-29T10:48:53.000+01:00
Author: | Steffen Hauf
Notes: | Added (only) class to src/tools. Additionally modified mpod.py for DSSC schema differences w.r.t. DEFAULT (=AGIPD original), which schema is used is controlled by a boolean property.

4.0.2-2.2.1

Created: | 2018-04-06T10:22:50.000+02:00
Author: | Wajid Ehsan
Notes: |

##### SWITCH

[add component documentation]

###### X1_OUT

Instance id: | SA2_XTD6_MCP/SWITCH/X1_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_MCP/MOTOR/X1|motorScene, SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, MAIN—MCP-Selector-Scene, SA2_MAIN_BKR-wallpaper, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### X2_OUT

Instance id: | SA2_XTD6_MCP/SWITCH/X2_OUT
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODES|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEM|InterlockOverview, SA2_SYS_EPS2MPS/DCTRL/MODEF|InterlockOverview, SA2_MAIN, SA2_XTD6_MCP/MOTOR/X2|motorScene, MAIN—MCP-Selector-Scene, SA2_MAIN_BKR-wallpaper, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODES_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT, SA2_SYS_EPS2MPS_DCTRL_MODEF_INTERLOCK_DRAFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### CAM_TRIGGER

Instance id: | SA2_XTD6_MCP/TSYS/CAM_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### UVLAMP_TRIGGER

Instance id: | SA2_XTD6_MCP/TSYS/UVLAMP_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### ADC_TRIGGER

Instance id: | SA2_XTD6_MCP/TSYS/ADC_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### MIRR-1

[add component documentation]

##### ACTRL

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-1/ACTRL/RY
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | Piezo_S2M1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-1/ACTRL/RZ
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | Piezo_S2M1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-1/ASENS/RY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | switch_to_MID, Piezo_S2M1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-1/ASENS/RZ
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | switch_to_MID, Piezo_S2M1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_MIRR-1/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-9
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | SA2_XTD6_MIRR-1/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### LED_POWER

Instance id: | SA2_XTD6_MIRR-1/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_MIRR-1/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RGA_ENABLE

Instance id: | SA2_XTD6_MIRR-1/DCTRL/RGA_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | SA2_RGA_XTRIP
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ENC

[add component documentation]

###### HMRX

Instance id: | SA2_XTD6_MIRR-1/ENC/HMRX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMRX_SETUP, SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMRX_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRY

Instance id: | SA2_XTD6_MIRR-1/ENC/HMRY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMRY_SETUP, SA2_XTD6_MIRR-1_MOTOR_HMRY_SETUP, SA2_Mirror_M1, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRZ

Instance id: | SA2_XTD6_MIRR-1/ENC/HMRZ
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMRZ_SETUP, SA2_XTD6_MIRR-1_MOTOR_HMRZ_SETUP, SA2_Mirror_M1, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTX

Instance id: | SA2_XTD6_MIRR-1/ENC/HMTX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMTX_SETUP, SA2_XTD6_MIRR-1_MOTOR_HMTX_SETUP, SA2_Mirror_M1, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTY

Instance id: | SA2_XTD6_MIRR-1/ENC/HMTY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-1, SA2_MAIN_copy
Scenes: | SA2_Mirror_M1, SA2_XTD6_MIRR-1_MOTOR_HMTY_SETUP, SA2_XTD6_MIRR-1_MOTOR_HMTY_SETUP, SA2_Mirror_M1, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### MOTOR

[add component documentation]

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

##### SWITCH

[add component documentation]

###### TX_SAFE

Instance id: | SA2_XTD6_MIRR-1/SWITCH/TX_SAFE
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MDL

[add component documentation]

###### MMOTIONS

#### MIRR-2

[add component documentation]

##### ACTRL

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-2/ACTRL/RY
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | HED_XTD6_FEEDBACK/MDL/MIRROR_2_FEEDBACK_old_scene, test_piezo, MID_XTD6_IMGPI/MDL/FEEDBACK|scene, Piezo_S2M2, SA2_Motor_Positions_Overview, HED_XTD6_FEEDBACK_M3/FeedbackOverviewHED, SA2_Motor_Positions_Overview, MID_XTD6_IMGPI/MDL/FEEDBACK/trendlines, HED_XTD6_FEEDBACK/MDL/MIRROR_2_FEEDBACK|scene
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-2/ACTRL/RZ
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | test_piezo, Piezo_S2M2, SA2_Motor_Positions_Overview, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### D1

Instance id: | SA2_XTD6_MIRR-2/ASENS/D1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER, SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### D2

Instance id: | SA2_XTD6_MIRR-2/ASENS/D2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER, SA2_Motor_Positions_Overview, SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### D3

Instance id: | SA2_XTD6_MIRR-2/ASENS/D3
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER, SA2_XTD10_MIRR-2-ASENS-DALL, SA2_XTD6_MIRR-2_MOTOR_BENDER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RY

Instance id: | SA2_XTD6_MIRR-2/ASENS/RY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | Piezo_S2M2, switch_to_MID
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-2/ASENS/RZ
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | Piezo_S2M2, switch_to_MID
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_MIRR-2/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-9
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | SA2_XTD6_MIRR-2/CAMERA, SA2_XTD6_MIRR-2/CAMERA, SA2_XTD6_MIRR-2/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### LED_POWER

Instance id: | SA2_XTD6_MIRR-2/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_MIRR-2/CAMERA, SA2_XTD6_MIRR-2/CAMERA, SA2_XTD6_MIRR-2/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RGA_ENABLE

Instance id: | SA2_XTD6_MIRR-2/DCTRL/RGA_ENABLE
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ENC

[add component documentation]

###### HMRX

Instance id: | SA2_XTD6_MIRR-2/ENC/HMRX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRX_SETUP, SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRX_SETUP, SA2_Motor_Positions_Overview, SA2_XTD6_MIRR-2/MDL/MMOTIONS|Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRY

Instance id: | SA2_XTD6_MIRR-2/ENC/HMRY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRY_SETUP, SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRY_SETUP, SA2_Motor_Positions_Overview, SA2_XTD6_MIRR-2/MDL/MMOTIONS|Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRZ

Instance id: | SA2_XTD6_MIRR-2/ENC/HMRZ
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRZ_SETUP, SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMRZ_SETUP, SA2_Motor_Positions_Overview, SA2_XTD6_MIRR-2/MDL/MMOTIONS|Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTX

Instance id: | SA2_XTD6_MIRR-2/ENC/HMTX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMTX_SETUP, SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMTX_SETUP, SA2_Motor_Positions_Overview, SA2_XTD6_MIRR-2/MDL/MMOTIONS|Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTY

Instance id: | SA2_XTD6_MIRR-2/ENC/HMTY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMTY_SETUP, SA2_Mirror_M2, SA2_XTD6_MIRR-2_MOTOR_HMTY_SETUP, SA2_Motor_Positions_Overview, SA2_XTD6_MIRR-2/MDL/MMOTIONS|Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### MDL

[add component documentation]

###### FOCUS_POSITION

Instance id: | SA2_XTD6_MIRR-2/MDL/FOCUS_POSITION
Class id: | MirrorFocusPosition
Host: | sa2-br-sys-con-2
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/mirrorFocusPosition
Last modified: | 2020-11-27T08:32:05.000+01:00
Created at: | 2019-06-05T17:51:14.000+02:00
Main authors: | Parenti, Hauf, Kirienko
Latest tag: | 0.3.0-2.10.0
Deployment tag: | 0.3.0-2.10.0
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- d1:
    Possible values are: SA1_XTD2_MIRR-2/ASENS/D1 for SA1; SA2_XTD6_MIRR-2/ASENS/D1 for SA2; SA3_XTD10_MIRR-2/ASENS/D1 for SA3
- d2:
    Possible values are: SA1_XTD2_MIRR-2/ASENS/D2 for SA1; SA2_XTD6_MIRR-2/ASENS/D2 for SA2; SA3_XTD10_MIRR-2/ASENS/D2 for SA3
- d3:
    Possible values are: SA1_XTD2_MIRR-2/ASENS/D3 for SA1; SA2_XTD6_MIRR-2/ASENS/D3 for SA2; SA3_XTD10_MIRR-2/ASENS/D3 for SA3
- motor:
    Possible values are: SA1_XTD2_MIRR-2/MOTOR/BENDER for SA1; SA2_XTD6_MIRR-2/MOTOR/BENDER for SA2; SA3_XTD10_MIRR-2/MOTOR/BENDER for SA3
- X:
    The main term in the focus position formula: FP = X + 1/[2/(rc × sin(ca)) - 1/(X-sp)]

Release History
0.3.0-2.10.0

Created: | 2020-11-27T08:32:54.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

0.2.0-2.6.4

Created: | 2019-11-14T15:03:25.000+01:00
Author: | Yury Kirienko
Notes: | Recommended for everyone, mandatory for SA1.

0.1.1-2.6.4

Created: | 2019-10-29T11:30:06.000+01:00
Author: | Yury Kirienko
Notes: |

rc0.1.1-2.5.1

Created: | 2019-08-13T12:33:01.000+02:00
Author: | Yury Kirienko
Notes: | RC tag, to be changed ASAP

###### MMOTIONS

##### MOTOR

[add component documentation]

###### BENDER

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

##### PMOTOR

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-2/PMOTOR/RY
Class id: | BeckhoffMC2Base
Host: | exflcon58n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    CHoming
- on:
    CEnableAxis
- off:
    CDisableAxis
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    CResetAxis
- specificError:
    ASpecificError
- moveRelative:
    CMoveRelative
- move:
    CMoveAbsolute
- emergencyStop:
    CStop
- stop:
    CHalt
- moveConstantVelocity:
    set property amovevelocity
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

###### RZ

Instance id: | SA2_XTD6_MIRR-2/PMOTOR/RZ
Class id: | BeckhoffMC2Base
Host: | exflcon58n0
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Warning

The velocity for this motor has not been commissioned. You may loose steps in case you set it too high!

BeckhoffMC2Base Documentation

The `BeckhoffMC2Base` device is documented here.

Autogenerated documentation for the device’s properties and slots can be found here.

The following is the documentation for the base underlying PLC soft device: SD_MC2Base.

Documentation can also be found for the derived soft devices:

- SD_MC2BECKHOFF
- SD_MC2ELMO
- SD_MC2HEXAPOD
- SD_MC2LARGESERVO
- SD_MC2NANOS
- SD_MC2PIEZO
- SD_MC2TECHNOSOFT.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    CHoming
- on:
    CEnableAxis
- off:
    CDisableAxis
- calibrateToEncoder:
    Calibrate actual position to encoder position.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- resetAxis:
    CResetAxis
- specificError:
    ASpecificError
- moveRelative:
    CMoveRelative
- move:
    CMoveAbsolute
- emergencyStop:
    CStop
- stop:
    CHalt
- moveConstantVelocity:
    set property amovevelocity
- actualPosition:
    AActualPosition
- stepSize:
    AMoveDistance
- targetVelocity:
    AMoveVelocity
- targetPosition:
    AAbsoluteTargetPosition
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at Interlock limit high.
- isInterlockLimitLow:
    Is at Interlock limit low.
- mc2DiscreteMotion:
    e.g. relative or absolute position movement
- mc2ContinuousMotion:
    e.g. constant velocity
- isOnTarget:
    Indicates whether the motor is on target or not.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

##### TSENS

[add component documentation]

###### BENDER1

Instance id: | SA2_XTD6_MIRR-2/TSENS/BENDER1
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_XTD6_MIRR-2_MOTOR_BENDER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BENDER2

Instance id: | SA2_XTD6_MIRR-2/TSENS/BENDER2
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Projects: | SA2_XTD6_MIRR-2, SA2_MAIN_copy
Scenes: | SA2_XTD6_MIRR-2_MOTOR_BENDER
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### AIR

#### MIRR-3

[add component documentation]

##### ACTRL

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-3/ACTRL/RY
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | HED_XTD6_FEEDBACK/MDL/MIRROR_FEEDBACk|scene, HED_XTD6_FEEDBACK/MDL/MIRROR_FEEDBACk|scene, CAM_RIGHT0, SA2_Motor_Positions_Overview, Piezo_S2M3, HED_XTD6_FEEDBACK_M3/scene_details, HED_XTD6_FEEDBACK_M3/FeedbackOverviewHED, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-3/ACTRL/RZ
Class id: | BeckhoffAnalogOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_Motor_Positions_Overview, Piezo_S2M3, SA2_Motor_Positions_Overview
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog output of DAC.
- scale:
    Scaling factor for analog value.
- offset:
    Linear offset for analog value.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ASENS

[add component documentation]

###### RY

Instance id: | SA2_XTD6_MIRR-3/ASENS/RY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | CAM_RIGHT0, Piezo_S2M3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### RZ

Instance id: | SA2_XTD6_MIRR-3/ASENS/RZ
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Piezo_S2M3
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EW_POSITION

Instance id: | SA2_XTD6_MIRR-3/ASENS/EW_POSITION
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### EW_VELOCITY

Instance id: | SA2_XTD6_MIRR-3/ASENS/EW_VELOCITY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### NS_POSITION

Instance id: | SA2_XTD6_MIRR-3/ASENS/NS_POSITION
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### NS_VELOCITY

Instance id: | SA2_XTD6_MIRR-3/ASENS/NS_VELOCITY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | Seismometer_velocity_NS
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VERT_POSITION

Instance id: | SA2_XTD6_MIRR-3/ASENS/VERT_POSITION
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### VERT_VELOCITY

Instance id: | SA2_XTD6_MIRR-3/ASENS/VERT_VELOCITY
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### CAM

[add component documentation]

###### BEAMVIEW

Instance id: | SA2_XTD6_MIRR-3/CAM/BEAMVIEW
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-9
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Installed tag: | 5.6.9-2.10.0
Scenes: | SA2_XTD6_GENERIC-CAMERA, SA2_XTD6_MIRR-3/CAMERA, SA2_XTD6_MIRR-3/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (5.6.9-2.10.0) does not match tags mentioned in the deployment ([‘5.7.5-2.11.1’])!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### LED_POWER

Instance id: | SA2_XTD6_MIRR-3/DCTRL/LED_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | SA2_XTD6_GENERIC-CAMERA, SA2_XTD6_MIRR-3/CAMERA, SA2_XTD6_MIRR-3/CAMERA
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### SIS_POWER

Instance id: | SA2_XTD6_MIRR-3/DCTRL/SIS_POWER
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### ENC

[add component documentation]

###### HMRX

Instance id: | SA2_XTD6_MIRR-3/ENC/HMRX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SA2_Mirror_M3, SA2_XTD6_MIRR-3_MOTOR_HMRX_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRY

Instance id: | SA2_XTD6_MIRR-3/ENC/HMRY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SA2_Mirror_M3, SA2_XTD6_MIRR-3_MOTOR_HMRY_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMRZ

Instance id: | SA2_XTD6_MIRR-3/ENC/HMRZ
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SA2_Mirror_M3, SA2_XTD6_MIRR-3_MOTOR_HMRZ_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTX

Instance id: | SA2_XTD6_MIRR-3/ENC/HMTX
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SA2_Mirror_M3, SA2_XTD6_MIRR-3_MOTOR_HMTX_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

###### HMTY

Instance id: | SA2_XTD6_MIRR-3/ENC/HMTY
Host: | exflcon58n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
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.10-2.6.1
Installed tag: | 4.3.10-2.6.1
Scenes: | SA2_Mirror_M3, SA2_XTD6_MIRR-3_MOTOR_HMTY_SETUP, SA2_Motor_Positions_Overview
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### MOTOR

[add component documentation]

###### HMRX

###### HMRY

###### HMRZ

###### HMTX

###### HMTY

##### MDL

[add component documentation]

###### MMOTIONS

#### MOV

[add component documentation]

##### MONITOR

[add component documentation]

###### C20605M

Instance id: | SA2_XTD6_MOV/MONITOR/C20605M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20606M

Instance id: | SA2_XTD6_MOV/MONITOR/C20606M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20607M

Instance id: | SA2_XTD6_MOV/MONITOR/C20607M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20704M

Instance id: | SA2_XTD6_MOV/MONITOR/C20704M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20906M

Instance id: | SA2_XTD6_MOV/MONITOR/C20906M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C20909M

Instance id: | SA2_XTD6_MOV/MONITOR/C20909M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21404M

Instance id: | SA2_XTD6_MOV/MONITOR/C21404M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21605M

Instance id: | SA2_XTD6_MOV/MONITOR/C21605M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C21705M

Instance id: | SA2_XTD6_MOV/MONITOR/C21705M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22006M

Instance id: | SA2_XTD6_MOV/MONITOR/C22006M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22103M

Instance id: | SA2_XTD6_MOV/MONITOR/C22103M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR, SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

###### C22306M

Instance id: | SA2_XTD6_MOV/MONITOR/C22306M
Host: | exflcon57n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beckhoffCrateStatus
Last modified: | 2019-03-21T11:06:21.000+01:00
Created at: | 2018-06-25T16:14:14.000+02:00
Main authors: | Mamchyk
Latest tag: | 1.0.0-2.3.5
Deployment tag: | 1.0.0-2.3.5
Installed tag: | 1.0.0-2.3.5
Scenes: | SA2_RACK_MONITOR
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.0.0-2.3.5

Created: | 2018-12-05T18:08:35.000Z
Author: | Denys Mamchyk
Notes: | This is a tag of working and tested version of device. After successful tests in SA2 it can be put now to deployment in all tunnels.

#### PBLM-1

[add component documentation]

##### AVG

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-1/AVG/L
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | PBLM-1_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### R

Instance id: | SA2_XTD6_PBLM-1/AVG/R
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | PBLM-1_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-1/CAM/L
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | PBLM-1_Overview, test, SA2_XTD6_PBLM-1/CAM/L|scene, CAM_LEFT, SA2_XTD6_PBLM-1/CAM/L
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### R

Instance id: | SA2_XTD6_PBLM-1/CAM/R
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | PBLM-1_Overview, CAM_RIGHT, SA2_XTD6_PBLM-1/CAM/R
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER_LEFT

Instance id: | SA2_XTD6_PBLM-1/DCTRL/CAM_POWER_LEFT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | PBLM-1_Overview, test, CAM_LEFT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_POWER_RIGHT

Instance id: | SA2_XTD6_PBLM-1/DCTRL/CAM_POWER_RIGHT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | PBLM-1_Overview, CAM_RIGHT
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### BLADE_LEFT

###### BLADE_RIGHT

##### PROC

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-1/PROC/L
Class id: | ImageProcessor
Host: | exflcon196
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | PBLM-1_Overview, CAM_LEFT
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### COLLISION_HOR

Instance id: | SA2_XTD6_PBLM-1/SWITCH/COLLISION_HOR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### BLADE_LEFT

Instance id: | SA2_XTD6_PBLM-1/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT

Instance id: | SA2_XTD6_PBLM-1/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### L_TRIGGER

Instance id: | SA2_XTD6_PBLM-1/TSYS/L_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### R_TRIGGER

Instance id: | SA2_XTD6_PBLM-1/TSYS/R_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### PBLM-2

[add component documentation]

##### AVG

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-2/AVG/L
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | PBLM-2_Overview_AVG, SA2_XTD6_PBLM-2/Camera_left_averager
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

###### R

Instance id: | SA2_XTD6_PBLM-2/AVG/R
Class id: | ImageAverager
Host: | exflcon196
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | PBLM-2_Overview_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Averager

The `ImageAverager` device is part of the imageProcessor package, and is documented in imageprocessor:image-averager-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- resetAverage:
    Reset averaged image.
- imagePath:
    The path within the channel, where the data is, such as data.image, digitizer.channel_1_A.raw.samples
- nImages:
    Number of images to be averaged.
- runningAverage:
    Calculate running average (instead of standard).
- runningAvgMethod:
    The algorithm used for calculating the running average.
- outFrameRate:
    The output frame rate.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### CAM

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-2/CAM/L
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | PBLM-2_Overview, CAM_LEFT, SA2_XTD6_PBLM-2/CAM/L, PBLM-2_Overview_AVG, PBLM-2_Overview_new, SA2_XTD6_PBLM-2/Camera_left_averager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

###### R

Instance id: | SA2_XTD6_PBLM-2/CAM/R
Class id: | LimaBaslerCamera
Host: | sa2-br-sys-con-11
Class documentation:
| LimaBaslerCamera
Alias: | sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/limaCameras
Last modified: | 2021-07-28T09:51:24.000+02:00
Created at: | 2017-01-06T16:32:44.000+01:00
Main authors: | Parenti, Hauf, Goeries
Latest tag: | 5.7.5-2.11.1
Deployment tag: | 5.7.5-2.11.1
Scenes: | PBLM-2_Overview, CAM_RIGHT, SA2_XTD6_PBLM-2/CAM/R, PBLM-2_Overview_AVG, PBLM-2_Overview_new
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

LIMA BASLER

The documentation of the Karabo device for Basler cameras can be found here

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- failedConnectionAttempts:
    Number of consecutive attempts to connect.
- frameRate:
    The rate of frames received from camera.
- frameRateOut:
    The rate of frames sent to output channels.
- cameraType:
    The camera type.
- cameraModel:
    The camera model.
- imageDepth:
    The image depth in bytes.
- triggerMode:
    The trigger mode.
- exposureTime:
    The exposure time.
- latencyTime:
    The latency time.
- nbFrames:
    The number of frames for an acquisition. 0 means unlimited.
- rotation:
    The image rotation.
- pollingInterval:
    The interval for polling the camera for read-out values.
- bufferSize:
    Size of the buffer for data to be written to output channels.
- cameraIp:
    The IP address of the camera. The hostname or serial number (sn://21803915) can be also used.
- interPacketDelay:
    Increasing this parameter will slow down the acquisition, but it will improve its stability, especially when multiple cameras are operated on the same control host. Therefore it is recommended to set it to the maximum value allowed by the sensor size and the desired frame rate.
- frameTransmissionDelay:
    Delay before image transmission on the Ethernet.Setting different values on synchronous camerasconnected to a single server can prevent concurrency issues
- packetSize:
    The packet size. Should be as large as possible. Try 8192 if jumbo frames are enabled on the network (MTU=9000), use 1444 otherwise.
- socketBufferSize:
    The socket buffer size. Should be automatically set by pylon, but if you get ‘SocketBufferSize not valid’ on acquisition start, you have to set a non-zero value here. Get ‘/sbin/sysctl net.core.rmem_max’, divide by 1024 to convert to kB, and put the value here.
- timeout:
    The acquisition will time out, if no frames are received after this time.
- autoGain:
    Set auto gain.
- gain:
    Set camera gain. Gain is a normalized value in the range 0 thru 1. Most camera models allow an exact gain setting, some have steps of a few %
- triggerActivation:
    The Trigger Activation parameter is used to select rising edge or falling edge triggering.
- imageType:
    This parameter is used to select the pixel format.
- acqFrameCount:
    This parameter is used to set the number of frames acquired in the multiframe acquisition mode
- temperature:
    Camera temperature. Not available for all models.

Release History
5.7.5-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images. This tag replaces 5.6.11-2.11.1.

5.6.11-2.11.1

Created: | 2021-07-27T15:34:49.000+02:00
Author: | Andrea Parenti
Notes: | Summary: fix shape in the schema for rotated images.

5.6.10-2.11.1-hotfix

Created: | 2021-07-27T09:57:41.000+02:00
Author: | Andrea Parenti
Notes: | fix schema

5.6.10-2.11.1

Created: | 2021-06-11T12:14:55.000+02:00
Author: | Andrea Parenti
Notes: | Summary: as 5.6.9-2.10.0, with just lima dependency re-tagged for 2.11.1.

5.7.4-2.10.4

Created: | 2021-06-09T11:54:35.000+02:00
Author: | Dennis Goeries
Notes: |

5.7.3-2.10.4

Created: | 2021-04-30T18:51:12.000+02:00
Author: | Andrea Parenti
Notes: | Summary: remove unneeded casting.

5.7.2-2.10.4

Created: | 2021-04-29T15:22:08.000+02:00
Author: | Andrea Parenti
Notes: | Summary: * Add acquisition timeout parameter to Basler; * Fix data types for Basler.

5.7.1-2.10.0

Created: | 2021-02-03T18:21:34.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Use LImA having cmake in its DEPENDS file.

5.7.0-2.10.0

Created: | 2021-01-27T16:53:26.000+01:00
Author: | Andrea Parenti
Notes: | Summary: Update LImA to v1.9.6

5.6.9-2.10.0

Created: | 2020-11-24T12:03:00.000+01:00
Author: | Andrea Parenti
Notes: | Summary: add version info

5.6.8-2.9.1

Created: | 2020-08-17T15:03:07.000+02:00
Author: | Andrea Parenti
Notes: | Summary: Update to latest imageSourcePy tag.

5.6.7-2.9.1

Created: | 2020-07-29T09:21:15.000+02:00
Author: | Andrea Parenti
Notes: | FIX initial ROI setting FIX: do not quit output write thread in case of exceptions

5.6.6-2.8.1

Created: | 2020-04-23T09:18:28.000+02:00
Author: | Andrea Parenti
Notes: | Use LImA tag which installs Karabo’s GSL.

5.6.5-2.8.1

Created: | 2020-04-08T11:00:15.000+02:00
Author: | Andrea Parenti
Notes: | Only try 5 times to auto-connect

5.6.4-2.8.1

Created: | 2020-03-30T09:10:27.000+02:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy, tag 1.1.2-2.8.1

5.6.3-2.8.1-testing

Created: | 2020-03-24T17:47:56.000+01:00
Author: | Denys Mamchyk
Notes: | Tag from branch, for testing only (not for deployment)

5.6.3-2.8.1

Created: | 2020-03-24T14:52:54.000+01:00
Author: | Andrea Parenti
Notes: |

5.6.2-2.7.1

Created: | 2020-02-19T15:29:17.000+01:00
Author: | Andrea Parenti
Notes: | Use imageSourcePy 1.0.1-2.7.1

5.6.1-2.7.0

Created: | 2020-01-10T10:34:31.000+01:00
Author: | Andrea Parenti
Notes: | Just refactoring - no functional change.

5.6.0-2.7.0

Created: | 2020-01-08T09:03:11.000+01:00
Author: | Andrea Parenti
Notes: | New basler scene. Make use of imageSourcePy.

##### DCTRL

[add component documentation]

###### CAM_POWER_LEFT

Instance id: | SA2_XTD6_PBLM-2/DCTRL/CAM_POWER_LEFT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | PBLM-2_Overview, CAM_LEFT, PBLM-2_Overview_AVG, PBLM-2_Overview_new, SA2_XTD6_PBLM-2/Camera_left_averager
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### CAM_POWER_RIGHT

Instance id: | SA2_XTD6_PBLM-2/DCTRL/CAM_POWER_RIGHT
Class id: | BeckhoffDigitalOutput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | PBLM-2_Overview, CAM_RIGHT, PBLM-2_Overview_AVG, PBLM-2_Overview_new
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### MOTOR

[add component documentation]

###### BLADE_LEFT

###### BLADE_RIGHT

##### PROC

[add component documentation]

###### L

Instance id: | SA2_XTD6_PBLM-2/PROC/L
Class id: | ImageProcessor
Host: | exflcon196
Class documentation:
| ImageProcessor
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-11-23T12:51:25.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Scenes: | CAM_LEFT, PBLM-2_Overview_AVG
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

##### SWITCH

[add component documentation]

###### COLLISION_HOR

Instance id: | SA2_XTD6_PBLM-2/SWITCH/COLLISION_HOR
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSENS

[add component documentation]

###### BLADE_LEFT

Instance id: | SA2_XTD6_PBLM-2/TSENS/BLADE_LEFT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BLADE_RIGHT

Instance id: | SA2_XTD6_PBLM-2/TSENS/BLADE_RIGHT
Class id: | BeckhoffAnalogInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

##### TSYS

[add component documentation]

###### L_TRIGGER

Instance id: | SA2_XTD6_PBLM-2/TSYS/L_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

###### R_TRIGGER

Instance id: | SA2_XTD6_PBLM-2/TSYS/R_TRIGGER
Class id: | X2TimerML
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/x2TimerML
Last modified: | 2021-08-31T10:50:41.260+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.1-2.11.0
Deployment tag: | 1.4.1-2.11.0
Installed tag: | 1.3.4-2.10.0
Projects: | SA2_DOOCS, SA2_MAIN_copy
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.3.4-2.10.0) does not match tags mentioned in the deployment ([‘1.4.1-2.11.0’])!

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.4.1-2.11.0

Created: | 2021-08-20T12:50:02.000+02:00
Author: | Wajid Ehsan
Notes: | Add pp slave trigger for all beamlines

1.4.0-2.10.4

Created: | 2021-05-07T16:01:37.000+02:00
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T13:32:43.000+01:00
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T12:40:13.000+02:00
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T17:26:12.000+01:00
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T14:52:19.000+01:00
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T14:34:06.000+01:00
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T15:40:18.000+01:00
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T14:28:36.000+01:00
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T16:30:13.000+01:00
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T18:12:29.000+01:00
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T15:39:22.000+01:00
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T11:20:12.000+01:00
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T14:32:11.000+02:00
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T14:55:56.000+02:00
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T18:25:20.000+02:00
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T15:45:47.000+02:00
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T16:00:31.000+02:00
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T13:55:02.000+01:00
Author: | Dennis Goeries
Notes: |

#### PBLM

[add component documentation]

##### MDL

[add component documentation]

###### ALARM

Instance id: | SA2_XTD6_PBLM/MDL/ALARM
Class id: | GenericEstimator
Host: | sa2-br-sys-con-9
Alias: | sa2-br-sys-con-9
Git repo: | https://git.xfel.eu/karaboDevices/genericWatchdog
Last modified: | 2021-09-29T14:50:14.801+02:00
Created at: | 2019-08-09T16:43:53.000+02:00
Main authors: | Mamchykd, Hauf
Latest tag: | 1.10.8-2.11.1
Deployment tag: | 1.10.8-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- initMode:
    INIT Mode is used to retrieve configuration from git.Restart will be needed after configuration is done
- gitGroup:
    Git Group for saving device configuration.
- hashNames:
    Configuration hash names to be saved to git.
- gitTimeOut:
    Timeout for Git operations
- username:
    Enter an authorized username to allow editing
- refreshFromGit:
    Load config from git repo
- confirm:
    Saves configuration hashes to git
- coeffsTable:
    The list of user-defined constants which may have different options to be selected in Configuration Editor without modifying formulas
- coeffsValues:
    The values of user-defined constants that correspond to the options selected by Userin Configuration Editor
- extrasTable:
    Extra Attributes assigned for the evaluated properties (minInc, maxInc, etc)
- aggregatedState:
    Shows the state of monitored inputs
- connectTimeout:
    Wait for connection during given period (sec)

Release History
1.10.8-2.11.1

Created: | 2021-08-20T20:53:50.000+02:00
Author: | mamchykd
Notes: | Tag from master, fix for https://in.xfel.eu/redmine/issues/102161

1.10.7-2.11.1

Created: | 2021-07-14T20:14:45.000+02:00
Author: | mamchykd
Notes: | Branch from master, contains a fix for #100527

1.10.6-2.11.1

Created: | 2021-06-24T14:35:44.000+02:00
Author: | Steffen Hauf
Notes: | Branch from master, contains a timestamp-related fix

1.10.5-2.10.0

Created: | 2021-01-28T17:13:16.000+01:00
Author: | mamchykd
Notes: | Tagged from master, a fix for a watchdog-related part of #79630

1.10.4-2.10.0

Created: | 2021-01-21T02:59:10.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, a fix for a watchdog-related part of #79630. Tested in SA3, recommended. To be replaced with the one from master later.

1.10.3-2.10.0

Created: | 2021-01-21T00:35:08.000+01:00
Author: | mamchykd
Notes: | Tagged from fix_order branch, for a watchdog-related part of #79630. To be tested

1.10.2-2.10.0

Created: | 2021-01-20T13:49:39.000+01:00
Author: | mamchykd
Notes: | Tagged from master, gitdevicemixin dependency updated

1.10.1-2.10.0

Created: | 2021-01-20T12:17:25.000+01:00
Author: | mamchykd
Notes: | Tagged from master, includes a fix for #79262 (import from karabo.native removed)

1.10.0-2.10.0

Created: | 2020-11-24T14:49:04.000+01:00
Author: | Gabriele Giovanetti
Notes: | tagged from master, includes auto-generated versioning

1.0.9-2.9.1

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch, contains git-based configurations and a fix for #67192, #53092. Tested with XPD/IMAGERS and XPD/MCP, is OK for deployment, but needs a special procedure to save a device configuration to Git

1.0.8-2.9.1-test

Created: | 2020-07-09T12:22:09.000+02:00
Author: | Riccardo Fabbri
Notes: | Tag from branch (for test only), contains git-based configurations and a fix for #67192, #53092 Not for deployment

1.0.7-2.8.1

Created: | 2020-03-27T19:08:02.000+01:00
Author: | mamchykd
Notes: | a tag from development branch, contains some needed 2.8.1-related fixes. A recommended version for testing

1.0.6-2.7.0-las

Created: | 2020-02-02T19:32:21.000+01:00
Author: | Denys Mamchyk
Notes: | an experimental tag from development branch to be tested in LAS, contains one-row configuration option both for estimator and actuator

1.0.6-2.7.0

Created: | 2020-01-31T10:00:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, represents the most recent stage of a device refactoring

1.0.5-2.7.0

Created: | 2020-01-28T11:20:15.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to error handling

1.0.4-2.7.0

Created: | 2020-01-22T17:58:46.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains updates related to connection and inputs state check

1.0.3-2.7.0

Created: | 2019-12-17T14:45:29.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains minor logging updates

1.0.2-2.6.1

Created: | 2019-11-29T15:22:28.000+01:00
Author: | Denys Mamchyk
Notes: | a tag from development branch, contains HIREX hotfix included

1.0.1-2.6.1-hirex

Created: | 2019-10-31T01:22:14.000+01:00
Author: | Denys Mamchyk
Notes: | tmp tag from branch, for hirex in sa2 only

1.0.1-2.6.1-test

Created: | 2019-10-21T12:21:19.000+02:00
Author: | Denys Mamchyk
Notes: | Tag for testing. Update for connectDevices in Evaluations

#### PRESHUT

[add component documentation]

##### DCTRL

[add component documentation]

###### OPEN

Instance id: | SA2_XTD6_PRESHUT/DCTRL/OPEN
Class id: | BeckhoffDigitalOutput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

##### SWITCH

[add component documentation]

###### IN_BEAM_1

Instance id: | SA2_XTD6_PRESHUT/SWITCH/IN_BEAM_1
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### IN_BEAM_2

Instance id: | SA2_XTD6_PRESHUT/SWITCH/IN_BEAM_2
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### IN_BEAM_3

Instance id: | SA2_XTD6_PRESHUT/SWITCH/IN_BEAM_3
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### IN_BEAM_4

Instance id: | SA2_XTD6_PRESHUT/SWITCH/IN_BEAM_4
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### OUT_BEAM_1

Instance id: | SA2_XTD6_PRESHUT/SWITCH/OUT_BEAM_1
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | SA2_MAIN, SA2_MAIN_BKR-wallpaper, MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### OUT_BEAM_2

Instance id: | SA2_XTD6_PRESHUT/SWITCH/OUT_BEAM_2
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### OUT_BEAM_3

Instance id: | SA2_XTD6_PRESHUT/SWITCH/OUT_BEAM_3
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

###### OUT_BEAM_4

Instance id: | SA2_XTD6_PRESHUT/SWITCH/OUT_BEAM_4
Class id: | BeckhoffDigitalInput
Host: | exflcon58n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-11-30T18:00:45.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi
Latest tag: | 4.4.1-2.10.0
Deployment tag: | 4.4.1-2.10.0
Scenes: | MID_PRESABS_MAIN
Accessible by: |

Warning

Host not accessible by [‘xctrl’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

4.3.20-2.9.8

Created: | 2020-11-03T08:43:56.000Z
Author: | Gabriele Giovanetti
Notes: | Deal with MC2 motors state updates on move command.

4.3.19-2.9.8-MC2-move-states-test

Created: | 2020-10-28T09:29:46.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8-manifold-valve-tests

Created: | 2020-10-14T09:39:07.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.19-2.9.8

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | Fixes issues with ScrollPump

4.3.19-2.9.4

Created: | 2020-10-08T11:47:41.000Z
Author: | Steffen Hauf
Notes: | For 2.9.4 builds

4.3.18-2.9.4-test-scrollpump2

Created: | 2020-09-30T15:22:11.000Z
Author: | Martin Teichmann
Notes: |

4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

#### SYS

[add component documentation]

##### SWITCH

[add component documentation]

###### BKF10008_G1_OK

Instance id: | SA2_XTD6_SYS/SWITCH/BKF10008_G1_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10008_G2_OK

Instance id: | SA2_XTD6_SYS/SWITCH/BKF10008_G2_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10008_G3_OK

Instance id: | SA2_XTD6_SYS/SWITCH/BKF10008_G3_OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10008_G4_BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/BKF10008_G4_BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### BKF10008_G4_REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/BKF10008_G4_REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20604V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20604V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20604V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20604V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20604V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20604V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20604V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20604V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20605M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20605M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20605M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20605M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20605M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20605M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20605M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20605M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20606M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20606M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20606M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20606M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20606M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20606M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20606M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20606M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20607M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20607M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20607M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20607M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20607M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20607M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20607M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20607M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608E_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608E_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608E_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608E_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK206
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20608M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20608M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20703V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20703V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20703V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20703V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20703V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20703V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20703V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20703V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20704M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20704M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20704M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20704M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20704M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20704M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20704M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20704M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20705E_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20705E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20705E_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20705E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20705E_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20705E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20705E_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20705E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK207
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20803V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20803V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK208
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20803V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20803V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK208
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20803V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20803V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK208
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20803V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20803V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK208
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20905V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20905V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20905V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20905V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20905V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20905V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20905V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20905V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20906M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20906M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20906M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20906M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20906M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20906M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20906M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20906M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20909M_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20909M_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20909M_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20909M_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20909M_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20909M_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20909M_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20909M_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20910E_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20910E_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20910E_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C20910E_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20910E_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20910E_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C20910E_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C20910E_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-2
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-2
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.5-2.11.1
Scenes: | RACK209, RACK209
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.5-2.11.1) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21005V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21005V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK210
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21005V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21005V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK210
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21005V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21005V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK210
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21005V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21005V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK210
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21103V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21103V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK211
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21103V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21103V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK211
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21103V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21103V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK211
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21103V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21103V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK211
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21203V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21203V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK212
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21203V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21203V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK212
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21203V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21203V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK212
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21203V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21203V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK212
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21302V_T1OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21302V_T1OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK213
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21302V_T2OK

Instance id: | SA2_XTD6_SYS/SWITCH/C21302V_T2OK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK213
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21302V_T3BALOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21302V_T3BALOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK213
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.8.2-2.11.1rc1

Created: | 2021-10-02T07:28:37.000+02:00
Author: | Alessandro Silenzi
Notes: | Release candidate for 4.8.2

4.6.5-2.11.1-rc1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.6.5-2.11.1

Created: | 2021-09-13T18:14:58.000+02:00
Author: | xctrl
Notes: |

4.8.1-2.11.4

Created: | 2021-08-23T15:36:04.000+02:00
Author: | Alessandro Silenzi
Notes: | Bugfixes: 1. fix wrong value on the PLC when a deprecated paramer has different type wrt. the recommended new one. 2. fix bug (introduced in 4.8.0-2.11.4) that made the devices stay in UNKNOWN state

4.8.0-2.11.4

Created: | 2021-08-12T10:32:15.000+02:00
Author: | Alessandro Silenzi
Notes: | Asynchronous registration of devices on BeckhoffCom (by means of slotInstanceNew HW state word parsed into bits

4.7.0-2.10.5_sa3_vacuum

Created: | 2021-07-28T14:22:45.000+02:00
Author: | Alessandro Silenzi
Notes: |

4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T16:13:27.000+02:00
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T13:56:55.000+02:00
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T16:09:11.000+02:00
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T11:55:43.000+02:00
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T19:31:48.000+02:00
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T14:39:34.000+02:00
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T09:49:13.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T14:46:29.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T08:19:59.000+02:00
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T07:43:58.000+02:00
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T18:15:29.000+02:00
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T09:43:30.000+01:00
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T09:52:30.000+01:00
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

###### C21302V_T3REDOK

Instance id: | SA2_XTD6_SYS/SWITCH/C21302V_T3REDOK
Class id: | BeckhoffDigitalInput
Host: | sa2-br-sys-con-1
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | sa2-br-sys-con-10 , sa2-br-sys-con-1 , sa2-br-sys-con-11
Git repo: | https://git.xfel.eu/karaboDevices/Beckhoff
Last modified: | 2021-10-07T15:11:02.053+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Mamchykd, Silenzi, Giovanetti
Latest tag: | 4.8.2-2.11.1rc1
Deployment tag: | 4.8.2-2.11.1rc1
Installed tag: | 4.6.0-2.11.0-rc2
Scenes: | RACK213
Accessible by: | CAL, CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.0-2.11.0-rc2) does not match tags mentioned in the deployment ([‘4.8.2-2.11.1rc1’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- pe